Bp_xtrtil NPM | npm.io

bp_xtrtil

bp_xtrtil is an NPM package that provides end-to-end encrypted (e2ee) secure communication between web services, built on top of the Matrix protocol. This package makes it easy to send and receive encrypted messages, create and manage rooms, and invite users to rooms.

Installation

To install the package, run the following command:

npm install bp_xtrtil

Usage

Import the package:

const bp_xtrtil = require("bp_xtrtil");marvk

Provide the user's login credentials (homeserver URL, username and password):

const loginCred = {
homeserverUrl: "https://matrix.org",
username: "your-username",
password: "your-password",
};

or in json file like this conf.json:

{
"homeserverUrl": "https://matrix.org",
"username": "yourUsername",
"password": "yourPassword"
}

Start the client with the provided credentials using object or file path to file with creds:

bp_xtrtil.runClient(filePath, loginCred)
.then(() => {
// Your code here
})
.catch((error) => {
console.error("Error while running client:", error);
});

Use the available functions to perform various tasks, such as sending encrypted messages, listening for encrypted messages, inviting users to a room, and more. See the following examples:

const roomsID = await bp_xtrtil.getJoinedRoomsID();
const roomId = roomsID[0];

const mess = {
albumId: 1,
id: 2,
title: "reprehenderit est deserunt velit ipsam",
url: "https://via.placeholder.com/600/771796",
thumbnailUrl: "https://via.placeholder.com/150/771796",
};

// Send an encrypted message
bp_xtrtil.sendEncryptedMessage(roomId, mess)
.then((response) => {
console.log(response);
})
.catch((error) => {
console.error("Error while sending encrypted message:", error);
});

// Listen for encrypted messages
bp_xtrtil.messageListenerEncrypted(
(message) => {console.log("Received message:", message);},
roomId
);