SDK for Swyx Web Extensions

The package exposes typed APIs for call control, user presence, phonebook access, call journal access and server-pushed events.

Installation

npm install @enreachde/swyx-web-extension-sdk

Requirements

• A compatible SwyxWare server
• A compatible SwyxIt!

Compatibility

The SDK major version is aligned to a SwyxIt! version.

| SDK major | Minimum SwyxIt! version | | --- | --- | | 1 | 15.00 |

Quickstart

import {
    CreateWebExtensionClient,
    ConnectionEvent,
    ConnectionReason,
    ConsoleLogger,
} from '@enreachde/swyx-web-extension-sdk';

const client = CreateWebExtensionClient();
const { connection, hub, hubBack } = client;
const logger = new ConsoleLogger();

hubBack.onConnectionStateChanged((event: ConnectionEvent, reason: ConnectionReason) => {
    logger.info('HubBack', 'onConnectionStateChanged', `Connection state changed: ${event}, ${reason}`);
});

await connection.Connect();

const user = await hub.GetLoggedInUser();
logger.info('Hub', 'GetLoggedInUser', `Logged in user: ${user.userName}`);

await connection.Disconnect(ConnectionReason.Shuttingdown, true);