YjsDocumentManager

Manages Y.Doc instances, sync protocol, connection state, and content change tracking for collaborative editing.

Creates and caches Y.Doc instances by DocumentKey, handles the Yjs sync protocol, tracks connection state, and notifies on content changes.

Creating an instance

Provide a clientId for attribution and a connId for echo suppression.


import { YjsDocumentManager } from "@stratasync/y-doc";
import type { YjsDocumentManagerConfig } from "@stratasync/y-doc";

const config: YjsDocumentManagerConfig = {
  clientId: "client-abc-123",
  connId: "conn-xyz-456"

Property	Type	Description
`clientId`	`string`	Logical client identity for attribution. Stable across tabs and sessions.
`connId`	`string`	Connection-scoped identity for echo suppression of `yjs_update` messages.

YjsDocumentManager: Manages Y.Doc... · Strata Sync


import type { DocumentKey } from "@stratasync/y-doc";
import type * as Y from "yjs";

const docKey: DocumentKey = {
  entityType: "Task",
  entityId: "task-123",
  fieldName: "description",
};

const doc: Y.Doc = documentManager.getDocument(docKey);
const fragment = doc.getXmlFragment("prosemirror");

Property	Type	Default	Description
`initialContent`	`string`	-	Initial text content to insert if the document is empty.


import type { DocumentConnectionState } from "@stratasync/y-doc";

const state: DocumentConnectionState =
  documentManager.getConnectionState(docKey);
// "disconnected" | "connecting" | "syncing" | "connected"

State	Description
`"disconnected"`	Not connected to the document.
`"connecting"`	Connection initiated, waiting for sync.
`"syncing"`	Sync step in progress.
`"connected"`	Fully synced and receiving live updates.


const stateVector: Uint8Array = documentManager.getStateVector(docKey);

const fullState: Uint8Array | null = documentManager.getEncodedState(docKey);

const updates: Uint8Array | null = documentManager.getUpdatesSince(
  docKey,
  remoteStateVector
);

Type	Message	Description
`"doc_view"`	`DocViewMessage`	Start or stop viewing a document.
`"doc_focus"`	`DocFocusMessage`	Signal editor focus or blur.
`"yjs_sync_step1"`	`YjsSyncStep1Message`	Send state vector to initiate sync.
`"yjs_update"`	`YjsUpdateToServerMessage`	Send a local Yjs update.

Type	Message	Description
`"yjs_sync_step2"`	`YjsSyncStep2Message`	Server response with missing updates.
`"yjs_update"`	`YjsUpdateMessage`	Remote update from another client.
`"session_state"`	`SessionStateMessage`	Session participants update.
`"live_editing_error"`	`LiveEditingErrorMessage`	Error codes: `NOT_FOUND`, `UNAUTHORIZED`, `INVALID_PAYLOAD`, `RATE_LIMITED`.


import { YjsDocumentManager } from "@stratasync/y-doc";
import type { DocumentKey } from "@stratasync/y-doc";

const manager = new YjsDocumentManager({
  clientId: "client-123",
  connId: "conn-456",
});

manager.setTransport(yjsTransport);

const docKey: DocumentKey = {
  entityType: "Task",
  entityId: "task-abc",
  fieldName: "description",
};

const unsubContent = manager.onContentChange(docKey, (content) => {
  renderPreview(content);
});

const unsubState = manager.onConnectionStateChange(docKey, (state) => {
  updateConnectionIndicator(state);
});

manager.connect(docKey, { initialContent: "Initial description" });

const doc = manager.getDocument(docKey);
const fragment = doc.getXmlFragment("prosemirror");

// Clean up
unsubContent();
unsubState();
manager.disconnect(docKey);
manager.destroy(docKey);

YjsDocumentManager

Creating an instance

YjsDocumentManager

Creating an instance

YjsDocumentManagerConfig

Setting the transport

API reference

getDocument

connect

ConnectOptions

disconnect

getConnectionState

DocumentConnectionState

onConnectionStateChange

onContentChange

getDerivedContent

applyRemoteUpdate

applySnapshot

getStateVector / getEncodedState / getUpdatesSince

destroy / destroyAll

Message types

Client messages (sent to server)

Server messages (received from server)

Full example