8.1.0 2023-02-07

8.1.0 (2023-02-07)

Bugfixes

• Fix vulnerability in JSON5 parser: json5/json5#295. (#457)

Internal Changes

• Add release.sh script to automate the release process. (#452)
• Use environment variables for version and ref_name in GitHub Actions. (#455)
• Fix typo in warning message: "Failed to exchnage the token". (#456)
• Improve Provisioning API rate limiting and fix response headers. (#458)

8.0.1 (2022-12-08)

Bugfixes

• Fix a bug where the PostgresStore would prevent the process from cleanly exiting. (#453)

8.0.0 (2022-11-30)

Note: The API for UserActivityTracker has changed. Please see #448 for more details.

Features

• Add debouncing support to UserActivityTracker (defaults to 60 seconds). (#448)

Bugfixes

• Fix postgres-store attempting to overwrite existing schema whenever ensureSchema is called. (#451)

7.0.0 (2022-11-24)

This release contains a typo fix for the publicly exported method Bridge.initalise (now Bridge.initialise)

Features

• Enable allow-listing of specific IP ranges for OpenAPI requests (when using the Provisioner API) without having to edit disallowedIpRanges. This is done via the new allowedIpRanges flag. (#443)
• Add implementation of a PostgreSQL datastore for use by other bridges. (#442)

Bugfixes

• Cleanup any outstanding Timer handles after running Bridge.close, which may prevent the process from closing. (#439)

Improved Documentation

• How-To guide: Remove advise to install matrix-appservice and other small improvements. (#432)

Deprecations and Removals

• Fix typo'd function name Bridge.initalise -> Bridge.initialise. (#440)

Internal Changes

• Use MatrixError and enforce type-checking on error values. (#441)

6.0.0 (2022-09-23)

Note The logging interface has changed in this release. Please see the notes below on how to upgrade.

Features

• Port the Logger class from matrix-hookshot to this SDK, granting JSON logging support and less noisy logs.
  Note: This change is breaking. Logging.get(...) becomes new Logger(...) and Logging.configure becomes Logger.configure. (#412)

Bugfixes

• Fix getBridgeVersion sometimes reporting "unknown" when the package.json is accessible. (#437)

Improved Documentation

• How-To guide: Remove advise to install matrix-appservice and other small improvements. (#432)

5.1.0 (2022-08-12)

Features

• You can now throw AppserviceHttpError errors inside the onUserQuery controller function to raise a HTTP error. Other exceptions will be treated as a HTTP 500 error. (#434)

Bugfixes

• Fix bug introduced in 5.0.0 which caused the /metrics endpoint to request authentication. The endpoint no longer requires authentication. (#435)

Improved Documentation

• Document supported platforms. (#430)

Internal Changes

• Add new CI workflow to check for signoffs. (#428)

5.0.0 (2022-07-26)

This release depends on Node.JS 16 or greater.

Bugfixes

• Matrix users on a server that has an explicit port specifier in the server name will now be supported. (#414)

Improved Documentation

• Improve CONTRIBUTING.md guide to make it applicable for all of the matrix.org bridge repos. (#404)

Deprecations and Removals

• Breaking: The matrix-js-sdk is no longer included in this SDK. This means:
  • The ClientFactory component has been removed.
  • The ContentRepo utility is now deprecated, and supports only getHttpUriForMxc
  • You can no longer get a js-sdk MatrixClient instance from an Intent object. (#401)
• The bridge now always authenticates requests made to /_matrix/app/v1/thirdparty/.... The Bridge options flag authenticateThirdpartyEndpoints has been removed. (#409)
• Drop support for Node 14. Support Node 16+.
  Intent.uploadContent no longer accepts a ReadStream content parameter. Convert your stream to a buffer before beginning an upload. (#415)

Internal Changes

• Improve error messasge raised when m.login.application_service is not provided by the homeserver. (#399)
• Update matrix-appservice to 1.0.0. (#423)

4.0.2 (2022-07-15)

Bugfixes

• Pin matrix-bot-sdk version to avoid inadvertently requiring Node 16. (#416)

4.0.1 (2022-04-07)

Bugfixes

• Fix an issue where the provisioner API's /v1/exchange_openid route would sometimes fail. (#397)

4.0.0 (2022-03-31)

Features

• Add new Provisioning and Widgets API, so that bridges can provide richer integration APIs (#365, #388)

Deprecations and Removals

• Drop support for Node 12. Support Node 14+. (#382)

Internal Changes

• Update typedoc to 0.22.9 (#377)
• Logging in as an appservice user (for encryption support) now uses m.login.application_service rather than the unstable prefix. This may break on homeservers that are not up to date with Matrix v1.2. (#389)
• Replace Buildkite with GitHub Actions for CI. (#392)