@swalvo/server
v0.1.0
Published
Official server SDK for the Swalvo hosted platform — mint short-lived RTC tokens, manage rooms, and read connection/error diagnostics from your own backend. Never for use in a browser.
Maintainers
Readme
@swalvo/server
Swalvo's backend SDK — mint short-lived RTC and chat tokens, manage rooms and live streams, and read connection/error diagnostics.
Part of Swalvo, open-source real-time communication infrastructure.
Never import this in a browser. It holds a permanent project API key. The browser gets a short-lived token that this SDK mints.
Install
npm install @swalvo/serverUse
Identity comes from your session — never from the request body, or any caller can claim to be anyone.
import { Swalvo } from '@swalvo/server';
const swalvo = new Swalvo({
apiKey: process.env.SWALVO_API_KEY!,
baseUrl: process.env.SWALVO_API_URL!, // https://api.swalvo.com
});
const grant = await swalvo.tokens.create({ room: roomId, identity: 'user-42' });
// grant = { token, endpoint, iceServers, telemetryUrl, expiresAt, ... }Hand grant to your frontend, which passes it to @swalvo/rtc.
Moderate a live call, change a participant's metadata, or send a data message from the server:
await swalvo.rooms.muteParticipant(roomId, 'alice', { kind: 'audio', muted: true });
await swalvo.rooms.updateParticipantPermissions(roomId, 'alice', { publish: false });
await swalvo.rooms.updateParticipant(roomId, 'alice', { attributes: { hand: 'raised' } });
await swalvo.rooms.sendData(roomId, 'meeting ends in 5 min', { topic: 'system' });
await swalvo.rooms.removeParticipant(roomId, 'alice');Verify a webhook delivery (pass the raw body):
import { verifyWebhook } from '@swalvo/server';
// Pass the request headers: `swalvo-signature` is checked first, then the
// legacy `raven-signature` header (same value) as a fallback.
const event = verifyWebhook(rawBody, req.headers, process.env.SWALVO_WEBHOOK_SECRET!);Errors
import { SwalvoError, isSwalvoError } from '@swalvo/server';Every failure carries the API's error code and HTTP status, so you branch on the cause rather than parse a message. Codes are listed in docs/error-codes.md.
Documentation
Python backend? See Swalvo's Python SDK. It is not on PyPI
yet — it will publish as swalvo-sdk.
License
MIT
