JavaScript SDK / Installation

Installation#

@zeligate/zeli-avatar is the JavaScript and TypeScript SDK for a hosted Zeli Avatar service. It has zero runtime dependencies: a browser already ships WebRTC, WebSockets and fetch, which is everything the session client uses.

Install#

npm install @zeligate/zeli-avatar

The package is @zeligate/zeli-avatar on npm, with released versions, package metadata and installation files.

The package is published with TypeScript declarations, so editors resolve types without a separate @types install.

Requirements#

• A running Zeli avatar avatar server and its base URL, for example https://zeli-avatar.zelibot.xyz. The URL must start with http:// or https://, and the client throws a ConfigurationError if it does not.
• Network access from the runtime to the avatar server for both HTTP signalling and the WebRTC media connection.
• A credential. In a browser that is a short-lived session token, never a full API key. See Authentication.

Browsers#

Nothing extra to install. The SDK uses only platform APIs:

Node#

Node has fetch from v18 and a global WebSocket from v22, but it has no WebRTC. Supply an implementation:

npm install @zeligate/zeli-avatar werift

import { RTCPeerConnection } from "werift";
import { ZeliClient, type RTCPeerConnectionLike } from "@zeligate/zeli-avatar";
 
const client = new ZeliClient({
  serverUrl: "https://zeli-avatar.zelibot.xyz",
  apiKey: process.env.ZELI_API_KEY,
  peerConnectionFactory: (config) =>
    new RTCPeerConnection(config) as unknown as RTCPeerConnectionLike,
});

On Node before v22, pass webSocketFactory as well. The package declares "engines": { "node": ">=18" }.

Verify#

import { ZeliClient, ZeliEvent } from "@zeligate/zeli-avatar";
 
const client = new ZeliClient({ serverUrl: "https://zeli-avatar.zelibot.xyz" });
console.log(Object.keys(ZeliEvent).length, "events available");

Next: the Quickstart.