Skip to main content

CollabKitRole

Roles are session-scoped. Editors are active collaborators and can write collaboration state. Viewers receive updates and can follow users, but cannot write stores, comments, presence, Yjs updates, storage, or broadcasts.

CollabKitUser

Represents a user in a room.
Note: room_id, created_at, and token are stripped from all WebSocket responses (broadcasts, join responses, user queries) for payload efficiency and security. They are still included in REST API responses (e.g., GET /users/:id, POST /users).

CollabKitRoom

Represents a collaboration room.

CollabKitOrganization

Represents an organization (account).

CollabKitClientOptions

Options passed to the CollabKitClient constructor.

CollabKitComment

Represents a comment (top-level or reply).

CollabKitUserSession

A user’s session record (join/leave timestamps).