Skip to Content
LYNKORIADocs

Install the SDKs

Choose the right package for your backend and app, and install it.

PackageRuns onUse it to
@lynkoria/serverNode.js 22.12+ (your backend)Create calls and conversations, mint user tokens, moderate, suspend users, verify webhooks.
@lynkoria/clientBrowsers; messaging also in JS runtimesConnect a user, send and receive messages, presence, typing, attachments, join calls.
@lynkoria/reactReact 18 or 19Hooks on top of @lynkoria/client: useConversation, useCall, usePresence and more.

All three are version 0.1.0, written in TypeScript and shipped as ES modules with type definitions.

Install

npm install @lynkoria/server
npm install @lynkoria/client @lynkoria/react

@lynkoria/client brings socket.io-client and livekit-client with it. livekit-client is only downloaded by the browser when a user joins a call, so messaging-only apps do not pay for the media engine.

To render calls with prebuilt UI, add LiveKit’s React components:

npm install @livekit/components-react @livekit/components-styles

Release status and access

The packages are restricted (publishConfig.access: restricted) and have not been published to a registry yet. Until the first release:

  • Inside the Lynkoria monorepo, depend on them as workspace packages ("@lynkoria/client": "workspace:*").
  • In a product repository, ask the platform team for packed tarballs (pnpm --filter @lynkoria/client pack) and install those files, or wait for the registry release.

Once published, configure your organization’s npm token for the @lynkoria scope, then install as shown above. Pin an exact version in your lockfile: before 1.0, a minor release may contain breaking changes, and its changelog will say so.

Runtime requirements

  • Backend: Node.js 22.12 or later (global fetch, AbortSignal.timeout; require() of the ES module packages). Node.js 20 is end-of-life. Never bundle @lynkoria/server into browser code; it requires a service key.
  • Browser: current Chrome, Edge, Firefox or Safari with WebSocket support. Camera and microphone require https:// or localhost.
  • React Native / other runtimes: messaging works if you pass fetch and an ids generator to createLynkoria. Native media (iOS/Android calls) is not supported by the bundled media adapter. See platform status.
  • Network: the API uses HTTPS and WebSocket (/socket.io/, WebSocket transport only). Media uses LiveKit over UDP, with TCP and TURN fallbacks. The media URL arrives with each join token, so no media hostname is configured in your app.

TypeScript

Every request and response type is exported. Import types from the package you already use:

import type { Message, Presence, ConversationEvent } from '@lynkoria/client';
import type { Call, JoinTokenResponse, WebhookEvent } from '@lynkoria/server';

On this page