@alaznah/protocol
v0.1.0
Published
Shared protocol contracts for Alaznah Calling
Readme
Alaznah Protocol
Package: @alaznah/protocol
Repo: alaznah/alaznah-protocol
Status: Public
Shared calling contracts for Alaznah — message shapes, media types, session helpers, and protocol version constants.
Used by:
- alaznah/alaznah-sdk (client SDK)
- alaznah/alaznah-signaling (signaling server — private)
- Alaznah Cloud hosted signaling
Keep clients and servers on the same major protocol version.
Install
npm install @alaznah/protocolUsage
import {
PROTOCOL_VERSION,
PROTOCOL_MAJOR,
} from '@alaznah/protocol';Apps and servers must agree on PROTOCOL_MAJOR. Treat major bumps as breaking wire changes and coordinate releases.
Versioning
- Patch / minor — additive, backward-compatible fields and events
- Major (
PROTOCOL_MAJOR) — breaking contract — ship SDK + cloud updates together
Develop
npm install
npm run build
npm test
npm run typecheckLinks
| Resource | URL | | --- | --- | | Docs (live) | docs.alaznah.com | | Console (live) | console.alaznah.com | | SDK | alaznah/alaznah-sdk | | Signaling (private) | alaznah/alaznah-signaling | | Examples | alaznah/alaznah-examples |
License
MIT — see LICENSE.
