@automerge/automerge-repo 2.5.2-alpha.0 → 2.5.2-alpha.1

package/dist/helpers/array.d.ts

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

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

@@ -0,0 +1 @@
+{"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

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

package/dist/index.d.ts

@@ -28,7 +28,9 @@
 export { DocHandle } from "./DocHandle.js";
 export { isValidAutomergeUrl, isValidDocumentId, parseAutomergeUrl, stringifyAutomergeUrl, interpretAsDocumentId, documentIdToBinary, generateAutomergeUrl, encodeHeads, decodeHeads, } from "./AutomergeUrl.js";
 export { Repo } from "./Repo.js";
-export { Presence, PeerPresenceView, PeerState, PresenceConfig, UserId, DeviceId, } from "./Presence.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 { 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,EACL,QAAQ,EACR,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,MAAM,EACN,QAAQ,GACT,MAAM,eAAe,CAAA;AACtB,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;AAiB1B,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,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;AAiB1B,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/index.js

@@ -28,7 +28,8 @@
 export { DocHandle } from "./DocHandle.js";
 export { isValidAutomergeUrl, isValidDocumentId, parseAutomergeUrl, stringifyAutomergeUrl, interpretAsDocumentId, documentIdToBinary, generateAutomergeUrl, encodeHeads, decodeHeads, } from "./AutomergeUrl.js";
 export { Repo } from "./Repo.js";
-export { Presence, PeerPresenceView, } from "./Presence.js";
+export { Presence } from "./presence/Presence.js";
+export { PeerStateView } from "./presence/PeerStateView.js";
 export { NetworkAdapter } from "./network/NetworkAdapter.js";
 export { isRepoMessage } from "./network/messages.js";
 export { StorageAdapter } from "./storage/StorageAdapter.js";

package/dist/presence/PeerPresenceInfo.d.ts

@@ -0,0 +1,50 @@
+import { PeerId } from "../types.js";
+import { PeerStateView } from "./PeerStateView.js";
+import { DeviceId, PresenceState, UserId } from "./types.js";
+export declare class PeerPresenceInfo<State extends PresenceState> {
+    #private;
+    readonly ttl: number;
+    /**
+     * 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: number);
+    has(peerId: PeerId): boolean;
+    /**
+     * Record that we've seen the given peer recently.
+     *
+     * @param peerId
+     */
+    markSeen(peerId: PeerId): void;
+    /**
+     * Record a state update for the given peer. Note that existing state is not
+     * overwritten.
+     *
+     * @param peerId
+     * @param value
+     */
+    update({ peerId, deviceId, userId, value, }: {
+        peerId: PeerId;
+        deviceId?: DeviceId;
+        userId?: UserId;
+        value: Partial<State>;
+    }): void;
+    /**
+     * Forget the given peer.
+     *
+     * @param peerId
+     */
+    delete(peerId: PeerId): void;
+    /**
+     * Prune all peers that have not been seen since the configured ttl has
+     * elapsed.
+     */
+    prune(): void;
+    /**
+     * Get a snapshot of the current peer states
+     */
+    get states(): PeerStateView<State>;
+}
+//# sourceMappingURL=PeerPresenceInfo.d.ts.map

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

@@ -0,0 +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;IAUvB;;;;;;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;IAWL;;OAEG;IACH,IAAI,MAAM,yBAET;CACF"}

package/dist/presence/PeerPresenceInfo.js

@@ -0,0 +1,83 @@
+import { PeerStateView } from "./PeerStateView.js";
+export 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;
+    }
+}

package/dist/presence/PeerStateView.d.ts

@@ -0,0 +1,69 @@
+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)[];
+    /**
+     * Get all devices.
+     *
+     * @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.
+     *
+     * @param userId
+     * @returns Array of peer ids for this user
+     */
+    getUserPeers(userId: UserId): PeerId[];
+    /**
+     * Get all peers for this device.
+     *
+     * @param deviceId
+     * @returns Array of peer ids for this device
+     */
+    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;
+    /**
+     * Get current ephemeral state value for this device's most-recently-active
+     * peer.
+     *
+     * @param deviceId
+     * @returns device's {@link State}
+     */
+    getDeviceState(deviceId: DeviceId): import("./types.js").PeerState<State> | undefined;
+}
+//# sourceMappingURL=PeerStateView.d.ts.map

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

@@ -0,0 +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"}

package/dist/presence/PeerStateView.js

@@ -0,0 +1,131 @@
+import { unique } from "../helpers/array.js";
+export 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];
+    }
+}

package/dist/presence/Presence.d.ts

@@ -0,0 +1,81 @@
+import { EventEmitter } from "eventemitter3";
+import { DocHandle } from "../DocHandle.js";
+import { DeviceId, PresenceConfig, PresenceEvents, PresenceState, UserId } from "./types.js";
+/**
+ * Presence encapsulates ephemeral state communication for a specific doc
+ * handle. It tracks caller-provided local state and broadcasts that state to
+ * all peers. It sends periodic heartbeats when there are no state updates.
+ *
+ * It also tracks ephemeral state broadcast by peers and emits events when peers
+ * send ephemeral state updates (see {@link PresenceEvents}).
+ *
+ * Presence starts out in an inactive state. Call {@link start} and {@link stop}
+ * to activate and deactivate it.
+ */
+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, }: {
+        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
+     * state to peers, and start sending heartbeats.
+     */
+    start({ initialState, heartbeatMs, peerTtlMs }: PresenceConfig<State>): void;
+    /**
+     * Return a view of current peer states.
+     */
+    getPeerStates(): import("./PeerStateView.js").PeerStateView<State>;
+    /**
+     * Return a view of current local state.
+     */
+    getLocalState(): State;
+    /**
+     * Update state for the specific channel, and broadcast new state to all
+     * peers.
+     *
+     * @param channel
+     * @param value
+     */
+    broadcast<Channel extends keyof State>(channel: Channel, value: State[Channel]): void;
+    /**
+     * Whether this Presence is currently active. See
+     * {@link start} and {@link stop}.
+     */
+    get running(): boolean;
+    /**
+     * Stop this Presence: broadcast a "goodbye" message (when received, other
+     * peers will immediately forget the sender), stop sending heartbeats, and
+     * stop listening to ephemeral-messages broadcast from peers.
+     *
+     * This can be used with browser events like
+     * {@link https://developer.mozilla.org/en-US/docs/Web/API/Window/pagehide_event | "pagehide"}
+     * or
+     * {@link https://developer.mozilla.org/en-US/docs/Web/API/Document/visibilitychange_event | "visibilitychange"}
+     * to stop sending and receiving updates when not active.
+     */
+    stop(): void;
+    private announce;
+    private broadcastLocalState;
+    private broadcastChannelState;
+    private resetHeartbeats;
+    private doBroadcast;
+    private send;
+    private startHeartbeats;
+    private stopHeartbeats;
+    private startPruningPeers;
+    private stopPruningPeers;
+}
+//# sourceMappingURL=Presence.d.ts.map

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

@@ -0,0 +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;IAYzB,OAAO,CAAC,gBAAgB;CAOzB"}