TypeScript/JavaScript SDK for Matrix bots
  • TypeScript 99.6%
  • Shell 0.2%
  • JavaScript 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Jason Robinson a1ff92340a Release 0.11.0-element.0
Replacing 0.10.2-element.0 which was a mistake.
2026-11-11 17:40:03 +02:00
.github Support Node 26 (#96) 2026-06-03 23:14:22 -04:00
docs fixed missing argument in RustSdkCryptoStorageProvider in bot encrypt docs 2026-06-07 13:22:42 +02:00
examples Upgrade crypto bindings (#384) 2026-01-15 19:10:24 -07:00
scripts Rename vector-im to element-hq where appropriate (#77) 2026-01-19 11:01:22 +00:00
src Removed all listener overrides 2026-11-02 08:51:30 +01:00
test Removed all listener overrides 2026-11-02 08:51:30 +01:00
.eslintrc.js Fix lint rules 2022-05-28 21:21:43 -06:00
.gitignore Add early support for encryption: Bootstrap process 2021-07-23 22:16:46 -06:00
.node-version Merge upstream v0.8.0 (#76) 2026-01-19 11:01:22 +00:00
.npmignore 0.1.10 2018-06-09 21:59:56 -06:00
CONTRIBUTING.md Fix license name 2022-05-29 15:50:06 -06:00
eslint.config.js Merge upstream v0.8.0 (#76) 2026-01-19 11:01:22 +00:00
jsdoc.json Fill out the documentation a bit more 2021-11-17 23:57:11 -07:00
LICENSE Merge branch 'main' 2023-08-11 13:13:40 -04:00
package.json Release 0.11.0-element.0 2026-11-11 17:40:03 +02:00
README.md fixed documentation link in readme 2026-05-31 13:43:51 +02:00
RELEASING.md Release 0.10.2-element.0 2026-11-11 17:35:50 +02:00
tsconfig-examples.json Merge upstream v0.8.0 (#76) 2026-01-19 11:01:22 +00:00
tsconfig-release.json Remove Jest types from release TSConfig (#89) 2026-04-27 23:49:20 -04:00
tsconfig.json Use ES2022 for Error causes 2023-11-29 09:49:10 +00:00
yarn.lock Update matrix-sdk-crypto-nodejs 2026-11-11 15:49:06 +02:00

matrix-bot-sdk

npm version

TypeScript/JavaScript SDK for Matrix bots. For help and support, visit #matrix-bot-sdk:t2bot.io

Documentation

Documentation for the project is available here.

Matrix version support

The Matrix protocol is versioned to ensure endpoints and functionality can safely rotate in and out of the ecosystem. The bot-sdk will assume it is connected to a homeserver with support for at least one of the last 2 versions, at the time of the bot-sdk's release. This means that if you connect the bot-sdk to a homeserver which is 3 or more Matrix versions out of date, things might not work for you.

It is recommended to update the bot-sdk as frequently as spec releases themselves (or faster) to avoid this situation, and watch the repo for updates in the event a release is delayed.

Note: Currently the bot-sdk does not throw an error if the server appears to be incompatible, however this might change in the future.