rocketchat/tsmatrixserverlib

federation support module : low level common methods

tsmatrixserverlib

typescript library for common functions compatible with gomatrixserverlib

JavaScript Library for Federation Server Project

This is a JavaScript invocable set of library methods, in the form of an npm module, supporting chat federation via a matrix.org compatible protocol.

This library is a port of the gomatrixservlib, currently a work-in-progress from matrix.org.

tsmatrixserverlib is written in TypeScript, although calling client can be in JavaScript or TypeScript.

We selected TypeScript over JavaScript because:

1. Golang is strongly typed, TypeScript adds type support to JavaScript; we feel this will make the porting exercise easier
2. tsmatrixserverlib will likely gain complexity over time with multiple contributors, and TypeScript is more suitable for team collaborating on complex project

The is work in progress. We will update this page from time to time.

Understanding the Federation Project

The project aims at replacing Hubot-Freddie bridge with Federation API taking its place.The concept of Federation API is originally derived from Federation API.Understanding the Federation API document is really necessary in order to contribute to Repository.The reference library is gomatrixserverlib.

Tsmatrixserverlib Task-List

• transaction.ts
• timestamp.ts
• stateresolution.ts
• signing.ts
• resolve.ts
• request.ts
• redactevent.ts
• keys.ts
• keyring.ts
• json.ts
• federationtypes.ts
• federationclient.ts
• eventcrypto.ts
• eventcontent.ts
• eventauth.ts
• event.ts
• clientevent.ts
• client.ts
• base64.ts

Set up tsmatrixserverlib with TypeScript & JavaScript Unit Tests

$ git clone https://github.com/RocketChat/tsmatrixserverlib.git
$ git checkout develop
$ sh run_tests.sh

*Contributions are welcome

tsmatrixserverlib's Issues

Query: Addition of Power Levels of user Required?

Description: In reference to gomatrixserverlib, do we require the inclusion of power levels in terms of Rocket.Chat?

State Resolution pending [WIP]

Description: the state resolution algorithm implementation from gomatrixserverlib to tsmatrixserverlib is pending

BUG: clientevent.ts to be tested properly

Description: the module clientevent.ts has to be tested properly to figure out what exactly is lacking from the origin gomatrixserverlib

TBD: Are third Party invites necessary in Rocket.Chat terms

Description:I have not included ThirdPartyinvite methods in tsmatrixserverlib. We can add it if it is found to be required

TBD: Json.ts as a module can be removed from the check list, as it is not required for tsmatrixserverlib(specifically)

Description: Json.ts, from gomatrixserverlib perspectives is required as JSON by default is not supported by golang. Where from Typescript perspectives( tsmatrixserverlib) i.e super set of JS does have json support. Hence most of the things are taken care by default. So json.ts as a module can be removed.

TBD: Event Schema Definition Required.

TBD: Reference to #23 on Rocket.CHat.Federation

Defect: Error handling to be done properly (to be fixed)

Description: Some of the codes/ modules donot have proper error handling

TBD: next step after tsmatrixserverlib

the tsmatrixserverlib is basically a helper lib to achieve federation. This lib is mainly a set of rules developed to handle the inbound federation (according to gomatrixserverlib ). So, to develop the federationsender, Reference to federationsender is required. More specifically to look into how the events are sent, we have look into roomserver.

Experimentation Result: GopherJS is unusable for system applications

Description: GopherJS engine fails on systems applications