typescript

SimpleX Chat JavaScript client

This is a TypeScript library that defines WebSocket API client for SimpleX Chat terminal CLI that should be run as a WebSockets server on any port:

simplex-chat -p 5225

Client API provides types and functions to:

create and change user profile (although, in most cases you can do it manually, via SimpleX Chat terminal app).
create and accept invitations or connect with the contacts.
create and manage long-term user address, accepting connection requests automatically.
create, join and manage group.
send and receive files.

chat bots: you can implement any logic of connecting with and communicating with SimpleX Chat users. Using chat groups a chat bot can connect SimpleX Chat users with each other.
control of the equipment: e.g. servers or home automation. SimpleX Chat provides secure and authorised connections, so this is more secure than using rest APIs.

Please share your use cases and implementations.

npm i simplex-chat
npm run build

See the example of a simple chat bot in squaring-bot.js:

start simplex-chat as a server on port 5225: simplex-chat -p 5225 -d test_db
run chatbot: node examples/squaring-bot
connect to chatbot via SimpleX Chat client using the address of the chat bot

Please refer to the available client API in client.ts.

This library uses @simplex-chat/types package with auto-generated bot API types