Skip to main content

Installation

Platformv0.9.11Recommended SDKv0.1.3Supported SDK range>=0.1.0 <0.2.0

Install the package

pnpm add @ki-kombinat/delphi-client-js-sdk

Sub-paths

The package exposes two entry points so you only pay for what you use.

import {DelphiClient, SessionClient} from '@ki-kombinat/delphi-client-js-sdk';

import {
DelphiClientProvider,
useDelphiSession,
useDelphiClientContext,
} from '@ki-kombinat/delphi-client-js-sdk/react';
  • The core entrypoint has no runtime dependencies and works in any modern browser.
  • The /react sub-path adds the provider and hooks. react (>=18) is a peer dependency and is only required when you import this sub-path.

ESM and CJS

The package ships a dual build with full .d.ts typings:

dist/
├── index.mjs / index.cjs Core entry
├── react/index.mjs / .cjs React entry
└── *.d.ts / *.d.cts Type declarations

sideEffects: false is declared so bundlers can tree-shake unused exports.

Peer dependencies

PackageRangeRequired when
react>=18Importing @ki-kombinat/delphi-client-js-sdk/react

The core SDK does not depend on React.

Browser requirements

  • WebSocket, fetch, and modern Promise / async support — i.e. any evergreen browser.
  • RTCPeerConnection — only required for the voice_conversation session mode (full WebRTC voice calls).

See Compatibility for the full matrix.

Next step

Sessions and modes — the central concept the rest of the SDK is built on.