Installation

Archived SDK documentation

This page preserves the previous SDK documentation and its existing URL. The generated API reference was produced from SDK 0.1.5, source commit 4db9fbe925bf07a4b95e936a5bb172d6ab5820bb. Handbook behavior and compatibility claims below are historical descriptions, not a newly verified support guarantee. For the reviewed version-specific reference, see the SDK 0.1.5 overview.

PlatformNot stated in sourceRecorded SDK recommendationNot stated in sourceRecorded SDK rangeNot stated in source

Install the package

pnpm

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

npm

npm install @ki-kombinat/delphi-client-js-sdk

yarn

yarn 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

Package	Range	Required when
react	>=18	Importing @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.