Bridging infrastructure for Application Services
JavaScript
Clone or download
Latest commit 8a0a704 May 8, 2017

README.md

Matrix Application Service Bridging Infrastructure

Build Status

This library sits on top of the core application service library and provides an API for setting up bridges quickly. Check out the HOW-TO for a step-by-step tutorial on setting up a new bridge.

API

A hosted reference can be found on GitHub Pages. Alternatively, build the docs using npm run gendoc. Each component's class constructor is exposed on require("matrix-appservice-bridge") so check each class for more information on how to use each component.

Architecture

 __________________________
|                          |
|   Your bridge e.g. IRC   |
|__________________________|
 __|___________________|___
|                          |
| matrix-appservice-bridge |
|__________________________|
 __|___________________|___
|                          |
|    matrix-appservice     |
|__________________________|

The bridge relies on matrix-appservice and matrix-js-sdk for their AS API and CS API implementations respectively. The bridge manages state for virtual users and provides many useful helper functions bridges may desire.

Components

The bridge is formed around "components". You can pick and choose which components you use, though some components depend upon other components. All components operate on data models defined in the bridge. You can directly construct components: the bridge exposes the class constructor.

BridgeStore

Provides basic document store (key-value) CRUD operations.

UserBridgeStore

Provides storage for matrix and remote users. Provides CRUD operations and mapping between different types of users.

RoomBridgeStore

Provides storage for matrix and remote rooms. Provides CRUD operations and mapping between different types of rooms.

ClientFactory

Provides a method to obtain a JS SDK MatrixClient in the context of a particular user_id and/or Request. This is used to send messages as other users.

Request / RequestFactory

An abstraction provided to identify a single request through the bridge. Can be used for request-context logging (each request has a unique ID) and metrics (each request can succeed or fail and has timers for how long they take to go through the bridge).

Intent

Provides a way to perform Matrix actions by intent rather than by raw API calls. This can be thought of as an extension to the client-server JS SDK. For example, intent.invite(roomId, invitee) would make sure that you are actually joined to the room roomId first (and will automatically join it if you aren't) before trying to send the invite.

Performing actions by intent makes creating bridges a lot easier. For example, if your bridge has no concept of inviting or joining rooms, then you don't need to care about it either in the bridge. Simply calling intent.sendMessage(roomId, text) would make sure that you are joined to the room first before sending the message.

ConfigValidator

Provides a way to validate a YAML file when provided with a schema file. Useful for setting your bridge-specific configuration information.

Cli

Processes command line arguments and runs the Bridge.

AppServiceBot

A wrapper around the JS SDK MatrixClient designed for use by the application service itself. Contains helper methods to get all rooms the AS is in, how many virtual / real users are in each, etc.

Bridge

The component which orchestrates other components: a "glue" component. Provides a way to start the bridge. This is the component most examples use. Has dependencies on most of the components listed above.

Data Models

  • MatrixRoom - A representation of a matrix room.
  • RemoteRoom - A representation of a third-party room.
  • MatrixUser - A representation of a matrix user.
  • RemoteUser - A representation of a third-party user.