connIdYjsDocumentManagerimport { YjsPresenceManager } from "@stratasync/y-doc";
const presenceManager = new YjsPresenceManager({
clientId: "client-abc-123",
connId: "conn-xyz-456",
});| Property | Type | Description |
|---|---|---|
clientId | string | Logical client identity for attribution. |
connId | string | Connection-scoped identity for echo suppression and ownership. |
Set before signaling presence. See YjsDocumentManager for transport setup.
presenceManager.setTransport(yjsTransport);Listens for session_state messages and sends doc_view and doc_focus messages.
Signals that you opened a document.
import type { DocumentKey } from "@stratasync/y-doc";
const docKey: DocumentKey = {
entityType: "Task",
entityId: "task-123",
fieldName: "description",
};
presenceManager.startViewing(docKey);Signature: startViewing(docKey: DocumentKey): void
Duplicate calls for the same document are ignored.
Signals that you closed a document. Auto-calls blur if editing.
presenceManager.stopViewing(docKey);Signature: stopViewing(docKey: DocumentKey): void
Signals editor focus. Auto-calls startViewing if not already viewing.
presenceManager.focus(docKey);Signature: focus(docKey: DocumentKey): void
Sends a doc_focus message with state "focus".
Signals editor blur.
presenceManager.blur(docKey);Signature: blur(docKey: DocumentKey): void
Sends a doc_focus message with state "blur".
Returns whether you're viewing a document.
const viewing: boolean = presenceManager.isViewing(docKey);Signature: isViewing(docKey: DocumentKey): boolean
Returns whether you're editing a document.
const editing: boolean = presenceManager.isEditing(docKey);Signature: isEditing(docKey: DocumentKey): boolean
Returns session state with active participants.
import type { SessionState } from "@stratasync/y-doc";
const session: SessionState | null = presenceManager.getSessionState(docKey);
if (session) {
const activeCount = session.participants.filter((p) => p.isEditing).length;
}Signature: getSessionState(docKey: DocumentKey): SessionState | null
Returns null if no session state has been received yet.
interface SessionState {
active: boolean;
participants: SessionParticipant[];
}| Property | Type | Description |
|---|---|---|
active | boolean | Whether the session is active (at least one participant). |
participants | SessionParticipant[] | List of participants. |
interface SessionParticipant {
userId: string;
isEditing: boolean;
}| Property | Type | Description |
|---|---|---|
userId | string | The participant's user ID. |
isEditing | boolean | Whether the participant is editing (focused). |
Fires with current state, then on each change.
const unsubscribe = presenceManager.onSessionStateChange(docKey, (session) => {
updateParticipantList(session.participants);
showCollaborationBadge(session.active);
});
unsubscribe();Signature: onSessionStateChange(docKey: DocumentKey, callback: (state: SessionState) => void): () => void
Returns an unsubscribe function.
Stops viewing all documents and clears state.
presenceManager.cleanup();Signature: cleanup(): void
User opens document --> startViewing() --> doc_view "start" sent
User clicks editor --> focus() --> doc_focus "focus" sent
User clicks elsewhere --> blur() --> doc_focus "blur" sent
User closes document --> stopViewing() --> doc_view "stop" sent
The server aggregates signals into SessionState updates and broadcasts to all participants.
import { YjsPresenceManager } from "@stratasync/y-doc";
import type { DocumentKey } from "@stratasync/y-doc";
const presenceManager = new YjsPresenceManager({
clientId: "client-123",
connId: "conn-456",
});
presenceManager.setTransport(yjsTransport);
const docKey: DocumentKey = {
entityType: "Task",
entityId: "task-abc",
fieldName: "description",
};
const unsubscribe = presenceManager.onSessionStateChange(docKey, (session) => {
const editors = session.participants.filter((p) => p.isEditing);
updateUI({ activeEditors: editors.length, isActive: session.active });
});
presenceManager.startViewing(docKey);
presenceManager.focus(docKey);
presenceManager.blur(docKey);
presenceManager.stopViewing(docKey);
unsubscribe();