API Reference
Audience: users.
This section documents the API contract for the current Roomful JavaScript SDK.
Contract Scope
Section titled “Contract Scope”- Package namespace:
@roomful/* - Source of truth for documented signatures: this
reference/section - Stability: stable for the published JavaScript SDK packages
When implementation and docs differ, open an issue with:
- package name
- observed behavior
- expected contract
- reproduction steps
Reference Pages
Section titled “Reference Pages”Collaboration primitives (v1.5)
Section titled “Collaboration primitives (v1.5)”- Viewport engine
- Locking engine
- Pointer engine
- Comments engine
- History engine
- Activity engine
- Agent approvals engine
- Recording engine
- The
.roomfulsession format - Session summarizer
Adapters
Section titled “Adapters”Additional reference
Section titled “Additional reference”- Advanced features
- Security model
- Cross-platform interop
- Persistent comments storage
- Next.js auth tokens
- Auth with Firebase, Supabase, and custom backends
- UI components
- Devtools and debugging
- Performance
- Type reference