Fix repository URL casing so npm provenance validates

Add npm publish workflow

.github/workflows/publish.yml

@@ -0,0 +1,81 @@
+name: Publish to npm
+
+# Publishes the package to npm whenever a GitHub Release is published.
+# It publishes the exact commit the release tag points to, so a pre-release
+# can be cut from any branch (e.g. a beta off `dev`) without that branch
+# having to be merged into master first.
+#
+# The release tag is the source of truth for the version:
+#   - Stable tag (e.g. v1.2.3)             -> published to the "latest"
+#                                             dist-tag; the version bump is
+#                                             committed back to master.
+#   - Pre-release tag (e.g. v1.2.3-beta.1) -> published to a matching dist-tag
+#                                             ("beta", "rc", ...); does NOT
+#                                             become "latest" and is NOT
+#                                             committed back to master.
+#
+# Authentication uses npm Trusted Publishing (OIDC) - no token or secret is
+# needed. Configure a trusted publisher for this package on npmjs.com:
+#   Repository: Skylar-Tech/node-red-contrib-matrix-chat
+#   Workflow:   publish.yml
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write   # commit the version bump back to master
+      id-token: write   # npm Trusted Publishing (OIDC) + provenance
+    steps:
+      - name: Check out the released commit
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+
+      - name: Update npm
+        # Trusted Publishing requires npm 11.5.1 or newer; Node 22 ships npm 10.
+        run: npm install -g npm@latest
+
+      - name: Determine version and dist-tag
+        id: ver
+        run: |
+          VERSION="${GITHUB_REF_NAME#v}"
+          if [[ "$VERSION" == *-* ]]; then
+            # pre-release, e.g. 1.0.0-beta.1 -> dist-tag "beta"
+            DIST_TAG="${VERSION#*-}"
+            DIST_TAG="${DIST_TAG%%.*}"
+            PRERELEASE=true
+          else
+            DIST_TAG=latest
+            PRERELEASE=false
+          fi
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "dist_tag=$DIST_TAG" >> "$GITHUB_OUTPUT"
+          echo "prerelease=$PRERELEASE" >> "$GITHUB_OUTPUT"
+          echo "Publishing $VERSION to npm dist-tag '$DIST_TAG' (prerelease=$PRERELEASE)"
+
+      - name: Set version
+        run: npm version "${{ steps.ver.outputs.version }}" --no-git-tag-version --allow-same-version
+
+      - name: Publish to npm
+        run: npm publish --provenance --access public --tag "${{ steps.ver.outputs.dist_tag }}"
+
+      - name: Commit version bump back to master
+        if: steps.ver.outputs.prerelease == 'false'
+        run: |
+          if git diff --quiet; then
+            echo "package.json already at ${{ steps.ver.outputs.version }}; nothing to commit."
+            exit 0
+          fi
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git commit -am "Set version to ${{ steps.ver.outputs.version }}"
+          git push origin HEAD:master \
+            || echo "::warning::Could not push the version bump to master (branch protection?). The package was still published."

README.md

@@ -1,73 +1,79 @@
 # node-red-contrib-matrix-chat
 [Matrix](https://matrix.org/) chat server client for [Node-RED](https://nodered.org/)
 
-***Currently we are in beta. We ask that you open any issues you have on our repository to help us reach a stable well tested version. Things may change & break before our first release so check changelog before updating.***
+***Currently in beta. Please report any issues in our repository to help us reach a stable, well-tested release. Breaking changes may occur before our first stable release, so be sure to check the changelog before updating.***
 
-If you need help with this feel free to join our public matrix room at [#node-red-contrib-matrix-chat:skylar.tech](https://app.element.io/#/room/#node-red-contrib-matrix-chat:skylar.tech)
+Join our public Matrix room for help: [#node-red-contrib-matrix-chat:skylar.tech](https://app.element.io/#/room/#node-red-contrib-matrix-chat:skylar.tech)
+
+[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/B0B51BM7C)
 
 ### Features
 
-The following is supported from this package:
+Supported functionality in this package includes:
 
-- End-to-end encryption
-  - [Currently a WIP](#end-to-end-encryption-notes)
-  - Can also use [pantalaimon](https://github.com/matrix-org/pantalaimon) as an alternative solution to E2EE (if you need multiple sessions synced up with keys)
-- Receive events from a room (messages, reactions, images, audio, locations, and files) whether encrypted or not
-- Send Images/Files (sending files to e2ee room doesn't currently encrypt them yet)
-- Edit messages
-- Send typing events (Bot is typing ...)
-- Delete events (messages, reactions, etc)
-- Decrypt files in e2ee rooms
-- Send HTML/Plain Text Message/Notice
-- React to messages
-- Register user's on closed registration Synapse servers using `registration_shared_secret` (Admin Only)
-- List out users on a Synapse server (Admin Only)
-- Get WhoIs info for a Synapse user (Admin Only)
-- Add/Edit Synapse users using the v2 API (requires a pre-existing admin account)
-- Deactivate users on Synapse servers (Admin Only)
-- Get a user list from a room
-- Kick user from room
-- Ban user from room
-- Join, Create, Invite, and Leave rooms
-- Synapse admin API to force add user to room (requires bot to be in same room already)
+- **End-to-end encryption (E2EE)** — send and receive encrypted messages (see the [encryption notes](#end-to-end-encryption-notes))
+- **Cross-signing & secure backup** — interactive setup from the server config node so the bot's own device shows as verified
+- **Device verification** — interactive SAS (emoji) verification, either from the server config node or with the `matrix-verification` flow nodes
+- **Receive events** from rooms: Messages, reactions, images, audio, locations, files, encrypted or unencrypted
+- **Fetch/modify room state**: Update room settings
+- **Paginate room history**
+- **Send files** to rooms, encrypted or unencrypted
+- **Send/edit messages** (supports plain text and HTML formats)
+- **Send typing notifications**
+- **Delete events** (messages, reactions, etc.)
+- **Decrypt files** in E2EE rooms
+- **React to messages**
+- **Admin tools**:
+  - Register users on closed Synapse servers (`registration_shared_secret`)
+  - Manage users, including listing, adding, editing, deactivating (Synapse API)
+  - Force-add users to rooms
+- **Room management**: Invite, kick, ban, join, create, and leave rooms
 
-
-Therefore, you can easily build a bot, chat relay, or administrate your Matrix server from within [Node-RED](https://nodered.org/).
+These features allow you to easily build bots, set up chat relays, or even administrate your Matrix server directly from [Node-RED](https://nodered.org/).
 
 ### Installing
 
-You can either install from within Node-RED by searching for `node-red-contrib-matrix-chat` or run this from within your Node-RED directory:
+**Requires Node.js 22 or newer** (this is a requirement of the bundled `matrix-js-sdk`).
+
+Install through Node-RED's UI by searching for `node-red-contrib-matrix-chat`, or use the following command inside your Node-RED directory:
+
 ```bash
 npm install node-red-contrib-matrix-chat
 ```
 
 ### Usage
-We have examples! [Check them out](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme)
 
-#### Extra functionality
-You are not limited by just the nodes we have created. If you turn on global access when setting up your Matrix Client you can access the client directly from any function node to write your own logic.
+Explore our [examples](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) to see the module in action.
 
-View an example [here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#use-function-node-to-run-any-command)
+#### Extending functionality
+
+You're not limited to just the nodes we've created. Enable global access in your Matrix Client to directly interact with the client from function nodes and create custom logic.
+
+[View an example here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#use-function-node-to-run-any-command).
 
 ### End-to-End Encryption Notes
-Currently, this module has no way of getting encryption keys from other devices on the same account. Therefore it is recommended you use the bot exclusively with Node-RED after it's creation. Failure to do so will lead to your bot being unable to receive messages from e2ee rooms it joined from another client. Shared secret registration makes this super easy since it returns a token and device ID.
 
-This module stores a folder in your Node-RED directory called `matrix-client-storage` and is it vital that you periodically back this up if you are using e2ee. This is where the client stores all the keys necessary to decrypt messages and if lost you will lose access to e2e rooms. If you move your client to another NR install make sure to migrate this folder as well (and do not let both the old and new client run at same time).
+- E2EE uses the Rust crypto stack from `matrix-js-sdk`. The first time a bot starts after upgrading from an older version, any existing (legacy libolm) crypto state is migrated automatically.
+- **Storage:** E2EE state is saved in a folder called `matrix-client-storage` within your Node-RED directory — each account's Rust crypto store is persisted there as `rust-crypto-store.v8` (snapshotted on shutdown and every 5 minutes). Setting up secure backup (below) lets you recover the account's keys even if this folder is lost.
+- **Cross-signing & secure backup — strongly recommended:** open the server config node and use the **Set up secure backup & cross-signing** button. It lets you unlock an existing secure backup with its recovery key, or create a fresh one; once done, the bot's own device is cross-signed and shows as verified to others. **Save the recovery key somewhere safe** — it is shown only once, and is the only way to restore the account's encryption keys if the crypto store is ever lost.
+- **Device verification:** there are two ways to verify devices —
+    - From the server config node, the **Pending verification requests** button opens a list of incoming requests and lets you complete the SAS (emoji) check interactively, no flow required.
+    - Or build your own flow: the `matrix-verification` node emits verification requests and phase changes, and `matrix-verification-action` accepts, starts, confirms, or cancels them (e.g. emailing the SAS emoji for a human to confirm). See the [device verification example](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#device-verification).
 
-Want to contribute? Any help on getting the last pieces of e2ee figured out would be greatly appreciated :)
+### Registering a User
 
-### Generate user
-You will need a user to use this module. Luckily this module comes with a node that allows you to register users to a homeserver using the secret registration endpoint. This is perfect because it returns an `access_token` as well as a `device_id` which is exactly what we need.
-
-[Click here](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) to see how to generate a user using secret registration
+This module includes a node to register users using the Synapse secret registration endpoint. It returns both an `access_token` and a `device_id`, perfect for setting up the bot.
 
+[Guide on registering a user via the web browser](https://skylar.tech/matrix-chat-bot-module-for-node-red/)
 
+[Guide on registering using shared secret registration](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#readme) (for server owners)
 
 ### Other Packages
 
-- [node-red-contrib-gamedig](https://www.npmjs.com/package/node-red-contrib-gamedig) - Query game servers from Node-RED!
+- [node-red-contrib-gamedig](https://www.npmjs.com/package/node-red-contrib-gamedig) - Query game servers from Node-RED.
 
 ### Contributing
-All contributions are welcome! If you do add a feature please do a pull request so that everyone benefits :)
 
-Sharing is caring!
+We welcome all contributions! Please submit a pull request if you add a feature so the whole community can benefit.
+
+**Sharing is caring!**

examples/README.md

@@ -1,267 +1,487 @@
 # Examples
-These are examples of what is possible with the [node-red-contrib-matrix-chat](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat) module for [Node-RED](https://nodered.org/)
 
-If you want to try any of them out just copy their JSON contents from their .json file and use the hamburger menu in Node-RED to import the flow.
+These examples showcase what is possible with the [node-red-contrib-matrix-chat](https://github.com/Skylar-Tech/node-red-contrib-matrix-chat) module for [Node-RED](https://nodered.org/).
 
 Build something cool with these nodes? Feel free to submit a pull request to share it!
 
+## Prerequisites
+
+- A Matrix account
+- Node-RED set up and running
+- Installed `node-red-contrib-matrix-chat` module
+
+## How to Use the Examples
+
+To try out any of the examples:
+
+1. Copy the JSON contents from the `.json` file linked in each example.
+2. In Node-RED, use the menu to import the flow:
+    - Click the hamburger menu (top right corner).
+    - Select **Import**.
+    - Paste the JSON and click **Import**.
+
 ## Index
 
-- [Create User with Shared Secret Registration](#create-user-with-shared-secret-registration)
-- [Create/Edit Synapse User](#createedit-synapse-user)
-- [Use function node to run any command](#use-function-node-to-run-any-command)
-- [Respond to "ping" with "pong"](#respond-to-ping-with-pong)
-- [Respond to "html" with an HTML message](#respond-to-html-with-an-html-message)
-- [Respond to "image" with an uploaded image](#respond-to-image-with-an-uploaded-image)
-- [Respond to "file" with an uploaded file](#respond-to-file-with-an-uploaded-file)
-- [Respond to "react" with a reaction](#respond-to-react-with-a-reaction)
-- [Accept room invites from specific user](#accept-room-invites-from-specific-user)
-- [Leave room when someone says "bye"](#leave-room-when-someone-says-bye)
-- [Remove messages containing "delete"](#remove-messages-containing-delete)
-- [Respond to "users" with full list of server users](#respond-to-users-with-full-list-of-server-users)
-- [Respond to "newroom" by creating new room and inviting user](#respond-to-newroom-by-creating-new-room-and-inviting-user)
-- [Respond to "joinroom <room_id_or_alias>" by joining mentioned room](#respond-to-joinroom-room_id_or_alias-by-joining-mentioned-room)
-- [Respond to "rooms <user_id>" with user's rooms (list server's rooms if <user_id> is left blank)](#respond-to-rooms-user_id-with-users-rooms-list-servers-rooms-if-user_id-is-left-blank)
-- [Respond to "whois <user_id>" with information about the user's session](#respond-to-whois-user_id-with-information-about-the-users-session)
-- [Respond to "room_users" with current room's users](#respond-to-room_users-with-current-rooms-users)
-- [Sending typing events to a room](#sending-typing-events-to-a-room)
-- [Download & store all received files/images](#download--store-all-received-filesimages)
-- [Kick/Ban user from room](#kickban-user-from-room)
-- [Deactivate user](#deactivate-user)
+**Click the ▶ example to ▼ expand**
 
+### User Management
 
-### Create user with Shared Secret Registration
+<details>
+<summary>Get or set current user display name</summary>
+
+[View JSON](get-set-displayname.json)
+
+This flow lets you get or set the displayname for the current user.
+
+![get-set-displayname.png](get-set-displayname.png)
+
+</details>
+
+<details>
+<summary>Set user avatar using URL</summary>
+
+[View JSON](set-avatar-from-url.json)
+
+Inject a URL to an image and Node-RED will fetch the contents, upload to matrix, then set the user avatar to the new mxc_url.
+
+This is a good example of how to use the upload file node.
+
+![set-avatar-from-url.png](set-avatar-from-url.png)
+
+</details>
+
+<details>
+<summary>Fetch user info by userId</summary>
+
+[View JSON](get-user.json)
+
+Note this only works for users that the bot shares a room with. It will attempt to fetch the user from local storage first and if not found will query the server for the data.
+
+![get-user.png](get-user.png)
+
+</details>
+
+<details>
+<summary>Create User with Shared Secret Registration</summary>
 
 [View JSON](shared-secret-registration.json)
 
-Use this flow to create users on servers with closed registration. You also use this endpoint to create your first admin user as it is the same as running the local python script on the server. This requires your registration secret from your homeserver.yaml Synapse server configuration file.
+Use this flow to create users on servers with closed registration. You can also use this endpoint to create your first admin user, as it is the same as running the local Python script on the server. This requires your registration secret from your `homeserver.yaml` Synapse server configuration file.
 
-Edit the object on the inject node to the user/pass combo you want to create and hit the inject button (to the left of the inject node).
+**Instructions:**
+
+1. Edit the object on the inject node to specify the desired username and password.
+2. Click the inject button (to the left of the inject node) to create the user.
 
 **Note:** This only works on Synapse servers.
 
-![shared-secret-registration.png](shared-secret-registration.png)
+![Shared Secret Registration](shared-secret-registration.png)
 
+</details>
 
-### Create/Edit Synapse User
+<details>
+<summary>Create/Edit Synapse User</summary>
 
 [View JSON](add-user-with-admin-user.json)
 
 Allows an administrator to create or modify a user account with a specified `msg.userId`.
 
-![add-user-with-admin-user.png](add-user-with-admin-user.png)
+![Create/Edit Synapse User](add-user-with-admin-user.png)
 
+</details>
 
-### Use function node to run any command
-
-[View JSON](custom-redact-function-node.json)
-
-If we do not have a node for something you want to do you can do this manually with a function node. We now have a node for removing events but this is still a good example.
-
-**Note:** You should make sure to catch any errors in your function node otherwise you could cause Node-RED to crash.
-
-To view what sort of functions you have access to check out the `client.ts` file from `matrix-js-sdk` [here](https://github.com/matrix-org/matrix-js-sdk/blob/master/src/client.ts).
-
-![custom-redact-function-node.png](custom-redact-function-node.png)
-
-
-
-### Respond to "ping" with "pong"
-
-[View JSON](respond-ping-pong.json)
-
-Use this flow to respond to anyone that says "ping" with "pong" into the same room.
-
-![respond-ping-pong.png](respond-ping-pong.png)
-
-
-
-### Respond to "html" with an HTML message
-
-[View JSON](respond-to-html-with-html.json)
-
-Use this flow to respond to anyone that says "html" with an example HTML message. This shows how easy it is to send HTML.
-
-![respond-to-html-with-html.png](respond-to-html-with-html.png)
-
-
-
-### Respond to "image" with an uploaded image
-
-[View JSON](respond-image-with-image.json)
-
-You will need an image on the machine running Node-RED. In this case example.png exists inside the Node-RED directory.
-
-![respond-image-with-image.png](respond-image-with-image.png)
-
-
-
-### Respond to "file" with an uploaded file
-
-[View JSON](respond-file-with-file.json)
-
-You will need a file on the machine running Node-RED. In this case sample.pdf exists inside the Node-RED directory.
-
-![respond-file-with-file.png](respond-file-with-file.png)
-
-
-
-### Respond to "react" with a reaction
-
-[View JSON](respond-react-with-reaction.json)
-
-Give a 👍 reaction when someone says "react"
-
-![respond-react-with-reaction.png](respond-react-with-reaction.png)
-
-
-
-### Accept room invites from specific user
-
-[View JSON](accept-room-invites.json)
-
-Accept room invites from specific user.
-
-![accept-room-invites.png](accept-room-invites.png)
-
-
-
-### Leave room when someone says bye
-
-[View JSON](leave-room-bye.json)
-
-Leave room when someone says "bye".
-
-![leave-room-bye.png](leave-room-bye.png)
-
-
-
-### Remove messages containing "delete"
-
-[View JSON](delete-event.json)
-
-Any messages containing "delete" will try to be removed by the client.
-
-![respond-react-with-reaction.png](delete-event.png)
-
-
-
-### Respond to "users" with full list of server users
-
-[View JSON](respond-users-list.json)
-
-When someone sends the text "users" they get a HTML message back containing all the current users on the server. If your server has a lot of users this paginates and sends a message with 25 users per message.
-
-This requires admin privileges.
-
-![respond-users-list.png](respond-users-list.png)
-
-
-### Respond to "newroom" by creating new room and inviting user
-
-[View JSON](respond-users-list.json)
-
-When someone sends "newroom" a new room will be created and the user that said the message will be invited. The client will also send a welcome message into the new room.
-
-![respond-newroom-invite.png](respond-newroom-invite.png)
-
-
-### Respond to "joinroom <room_id_or_alias>" by joining mentioned room
-
-[View JSON](respond-joinroom.json)
-
-When someone sends "newroom" a new room will be created and the user that said the message will be invited. The client will also send a welcome message into the new room.
-
-![respond-joinroom.png](respond-joinroom.png)
-
-### Respond to "rooms <user_id>" with user's rooms (list server's rooms if <user_id> is left blank)
-
-[View JSON](respond-rooms.json)
-
-Responds to "rooms <user_id>" with that user's rooms. If the message is just "rooms" it responds with a list of all rooms the server is participating in.
-
-Note: If there are a lot of rooms this may fail to send the message as it is too large. This also only works for user's that are on the current server.
-
-This requires admin privileges.
-
-![respond-rooms.png](respond-rooms.png)
-
-
-### Respond to "whois <user_id>" with information about the user's session
-
-[View JSON](respond-whois.json)
-
-This lists out the user's session info. Each session contains the IP address, when it was last seen, and the user agent. Useful to find out more about a specific user on your server.
-
-Note: If there are a lot of sessions this may fail to send the message as it is too large. This also only works for user's that are on the current server.
-
-This requires admin privileges.
-
-![respond-whois.png](respond-whois.png)
-
-
-### Respond to "room_users" with current room's users
-
-[View JSON](respond-room-users.json)
-
-List out the users participating in a room.
-
-Note: If there are a lot of users in the room this will fail to send due to a large message error.
-
-![respond-room-users.png](respond-room-users.png)
-
-
-### Download & store all received files/images
-
-[View JSON](store-received-files.json)
-
-Download received files/images. If the file is encrypted it will decrypt it for you. The decrypt node downloads the file for you otherwise you need to use a HTTP Request node to download the file.
-
-Note: You may need to edit the storage directory for this to work. Default action is to create a `downloads` folder in the Node-RED directory and places files in that but there is a good chance your Node-RED instance doesn't have access to write to this directory.
-
-![store-received-files.png](store-received-files.png)
-
-
-### Sending typing events to a room
-
-[View JSON](send-typing-events.json)
-
-You can tell a room that Node-RED is writing a message and also cancel the writing event. This can be useful for making bots feel more interactive (show typing while requesting API endpoint for example).
-
-![store-received-files.png](send-typing-events.png)
-
-
-### Kick/Ban user from room
-
-[View JSON](room-kick-ban.json)
-
-If you say "kick @test:example.com" the bot will kick @test:example.com from the current room.
-
-If you say "ban @test:example.com" the bot will ban @test:example.com from the current room.
-
-Note: This requires the bot to have permissions to kick/ban in the current room.
-
-![room-kick-ban.png](room-kick-ban.png)
-
-
-### Deactivate user
+<details>
+<summary>Deactivate User</summary>
 
 [View JSON](deactivate-user.json)
 
-If you say "deactivate_user @test:example.com" the bot will deactivate the @test:example.com account on the server.
+If you send "deactivate_user @test:example.com", the bot will deactivate the `@test:example.com` account on the server.
 
-Note: This requires the bot to be a server admin. 
+**Note:**
 
-WARNING: Accounts that are deleted cannot be restored. If you want to temp-disable edit the user instead.
+- This requires the bot to be a server admin.
+- **WARNING:** Accounts that are deleted cannot be restored. If you want to temporarily disable a user, consider modifying the user instead.
 
-![room-kick-ban.png](deactivate-user.png)
+![Deactivate User](deactivate-user.png)
 
-### Force user to join room
+</details>
+
+<details>
+<summary>Force User to Join Room</summary>
 
 [View JSON](force-join-room.json)
 
-If you say "force_join @test:example.com !320j90mf0394f:example.com" the bot will force the user `@test:example.com` into room `!320j90mf0394f:example.com`
+If you send "force_join @test:example.com !320j90mf0394f:example.com", the bot will force the user `@test:example.com` into room `!320j90mf0394f:example.com`.
 
-Note: This requires the bot to be a server admin. This also only works for rooms on the same server.
+**Note:**
 
-![room-kick-ban.png](force-join-room.png)
+- This requires the bot to be a server admin.
+- This only works for rooms on the same server.
+
+![Force User to Join Room](force-join-room.png)
+
+</details>
+
+### Message Handling
+
+<details>
+<summary>Upload file and send to room</summary>
+
+[View JSON](send-image-to-room.json)
+
+This flow will download an image from a given URL and upload it to the matrix server then send it to a room.
+
+This isn't just for images and supports any sort of file format. Videos, images, and audio files will have metadata detected automatically and appended to the message (duration, dimensions, thumbnail, etc)
+
+![img.png](send-image-to-room.png)
+
+</details>
+
+<details>
+<summary>Respond to "ping" with "pong"</summary>
+
+[View JSON](respond-ping-pong.json)
+
+Use this flow to respond to anyone who says "ping" with "pong" in the same room.
+
+![Respond to "ping" with "pong"](respond-ping-pong.png)
+
+</details>
+
+<details>
+<summary>Respond to "html" with an HTML Message</summary>
+
+[View JSON](respond-to-html-with-html.json)
+
+Use this flow to respond to anyone who says "html" with an example HTML message. This shows how easy it is to send HTML content.
+
+![Respond to "html" with HTML Message](respond-to-html-with-html.png)
+
+</details>
+
+<details>
+<summary>Respond to "react" with a Reaction</summary>
+
+[View JSON](respond-react-with-reaction.json)
+
+Gives a 👍 reaction when someone says "react".
+
+![Respond to "react" with Reaction](respond-react-with-reaction.png)
+
+</details>
+
+<details>
+<summary>Remove Messages Containing "delete"</summary>
+
+[View JSON](delete-event.json)
+
+Any messages containing "delete" will be removed by the client.
+
+**Note:** The bot needs appropriate permissions to remove messages.
+
+![Remove Messages Containing "delete"](delete-event.png)
+
+</details>
+
+### Event Handling
+
+<details>
+<summary>Sending Typing Events to a Room</summary>
+
+[View JSON](send-typing-events.json)
+
+You can indicate to a room that the bot is typing and also cancel the typing event. This can be useful for making bots feel more interactive (e.g., show typing while requesting an API endpoint).
+
+![Sending Typing Events](send-typing-events.png)
+
+</details>
+
+<details>
+<summary>Mark all received events as read</summary>
+
+[View JSON](mark-all-read.json)
+
+With this flow anytime an event is received by the bot it will mark it as read.
+
+![mark-all-read.png](mark-all-read.png)
+
+</details>
+
+<details>
+<summary>Fetch event by eventId and roomId</summary>
+
+[View JSON](get-event.json)
+
+Fetch an event from Matrix by eventId and roomId
+
+**Instructions:**
+
+- Change the inject node to contain a proper eventId and roomId (topic)
+- Inject the payload and you should see the result contain the event data
+
+![get-event.png](get-event.png)
+
+</details>
+
+<details>
+<summary>Paginate the entire history of a given room</summary>
+
+[View JSON](paginate-room-history.json)
+
+This flow iterates the entire history of a room (outputting for every page we hit).
+
+There is a configurable delay (currently set at 1000ms) in this flow. This is recommended, so you are not bogging down the server.
+
+![paginate-room-history.png](paginate-room-history.png)
+
+</details>
+
+<details>
+<summary>Paginate related events to a given eventId</summary>
+
+[View JSON](fetch-event-relations.json)
+
+Paginate through the related events to a given eventId. Related events being reactions, thread messages, message modifications, message removals, etc. This outputs once per iterated page.
+
+If you would rather have it output one massive list at the end of pagination use this flow:
+[View Aggregated Flow JSON](fetch-event-relations-aggregated.json)
+
+**Instructions:**
+
+- Change the inject node to contain a proper eventId and roomId (topic)
+- Inject the payload and you should see the result contain a list of related events for the given eventId
+
+![fetch-event-relations.png](fetch-event-relations.png)
+
+</details>
+
+### Room Management
+
+<details>
+<summary>Set room name and topic</summary>
+
+[View JSON](set-room-name-and-topic.json)
+
+Changes the specified room's name and topic to the injected values.
+
+There are a bunch of different settings you can change, this is just an example for these two fields to show how it's done.
+
+This node can also be used to read these values.
+
+![set-room-name-and-topic.png](set-room-name-and-topic.png)
+
+</details>
+
+<details>
+<summary>Accept Room Invites from Specific User</summary>
+
+[View JSON](accept-room-invites.json)
+
+Automatically accept room invites from a specific user.
+
+![Accept Room Invites from Specific User](accept-room-invites.png)
+
+</details>
+
+<details>
+<summary>Leave Room When Someone Says "bye"</summary>
+
+[View JSON](leave-room-bye.json)
+
+Leaves the room when someone says "bye".
+
+![Leave Room When Someone Says "bye"](leave-room-bye.png)
+
+</details>
+
+<details>
+<summary>Respond to "newroom" by Creating a New Room and Inviting User</summary>
+
+[View JSON](respond-newroom-invite.json)
+
+When someone sends "newroom", a new room will be created, and the user who sent the message will be invited. The bot will also send a welcome message into the new room.
+
+![Respond to "newroom" by Creating New Room](respond-newroom-invite.png)
+
+</details>
+
+<details>
+<summary>Respond to "joinroom &lt;room_id_or_alias&gt;" by Joining Mentioned Room</summary>
+
+[View JSON](respond-joinroom.json)
+
+When someone sends "joinroom &lt;room_id_or_alias&gt;", the bot will join the mentioned room.
+
+![Respond to "joinroom" by Joining Room](respond-joinroom.png)
+
+</details>
+
+<details>
+<summary>Kick/Ban User from Room</summary>
+
+[View JSON](room-kick-ban.json)
+
+- If you say "kick @test:example.com", the bot will kick `@test:example.com` from the current room.
+- If you say "ban @test:example.com", the bot will ban `@test:example.com` from the current room.
+
+**Note:** This requires the bot to have permissions to kick/ban in the current room.
+
+![Kick/Ban User from Room](room-kick-ban.png)
+
+</details>
+
+### User Information
+
+<details>
+<summary>Respond to "users" with Full List of Server Users</summary>
+
+[View JSON](respond-users-list.json)
+
+When someone sends the text "users", they receive an HTML message containing all the current users on the server. If your server has many users, this paginates and sends messages with 25 users per message.
+
+**Notes:**
+
+- This requires admin privileges.
+- If there are many users, the bot may send multiple messages due to message size limits.
+
+![Respond to "users" with User List](respond-users-list.png)
+
+</details>
+
+<details>
+<summary>Respond to "whois &lt;user_id&gt;" with Information about the User's Session</summary>
+
+[View JSON](respond-whois.json)
+
+Lists out the user's session info, including IP address, last seen time, and user agent. Useful for finding out more about a specific user on your server.
+
+**Notes:**
+
+- This requires admin privileges.
+- If the user has many sessions, the message may be too large to send in one piece.
+
+![Respond to "whois" with User Session Info](respond-whois.png)
+
+</details>
+
+<details>
+<summary>Respond to "rooms &lt;user_id&gt;" with User's Rooms</summary>
+
+[View JSON](respond-rooms.json)
+
+Responds to "rooms &lt;user_id&gt;" with that user's rooms. If the message is just "rooms", it responds with a list of all rooms the server is participating in.
+
+**Notes:**
+
+- This requires admin privileges.
+- If there are many rooms, the message may be too large to send in one piece.
+- This only works for users on the current server.
+
+![Respond to "rooms" with Room List](respond-rooms.png)
+
+</details>
+
+<details>
+<summary>Respond to "room_users" with Current Room's Users</summary>
+
+[View JSON](respond-room-users.json)
+
+Lists the users participating in the current room.
+
+**Note:** If there are many users in the room, the message may be too large to send.
+
+![Respond to "room_users" with User List](respond-room-users.png)
+
+</details>
+
+### Advanced Features
+
+<details>
+<summary>Use Function Node to Run Any Command</summary>
+
+[View JSON](custom-redact-function-node.json)
+
+If there isn't a node for something you want to do, you can use a function node to manually execute commands. For example, you can redact events (remove messages).
+
+**Instructions:**
+
+- Use the function node to write custom commands using the `matrix-js-sdk` client.
+- Make sure to catch any errors in your function node to prevent Node-RED from crashing.
+
+To view the available functions, check out the [`client.ts` file from `matrix-js-sdk`](https://github.com/matrix-org/matrix-js-sdk/blob/master/src/client.ts).
+
+![Use Function Node to Run Commands](custom-redact-function-node.png)
+
+</details>
+
+<details>
+<summary>Download & Store All Received Files/Images</summary>
+
+[View JSON](store-received-files.json)
+
+Downloads received files/images. If the file is encrypted, it will decrypt it for you. The decrypt node downloads the file; otherwise, you need to use an HTTP Request node to download the file.
+
+**Instructions:**
+
+- You may need to edit the storage directory for this to work.
+- By default, files are saved in a `downloads` folder in the Node-RED directory.
+- Ensure that Node-RED has permission to write to the specified directory.
+
+![Download & Store Received Files](store-received-files.png)
+
+</details>
+
+### Device Verification
+
+<details>
+<summary>Handle device verification (SAS / emoji)</summary>
+
+[View JSON](device-verification-flow.json)
+
+An end-to-end example of interactive device verification. The `matrix-verification` node emits every verification request and phase change; the flow routes by phase, automatically **accepts** incoming requests and **starts SAS**, then surfaces the SAS emoji so a human can compare it. Inject nodes let you **confirm** or **reject** the match, and there are paths to have the bot **request** verification of a specific user's device, or a user in a room.
+
+Requires end-to-end encryption to be enabled on the server config node. For the bot's own device to be trusted by others, also set up cross-signing via the **Set up secure backup & cross-signing** button on the server config node.
+
+**Instructions:**
+
+1. Import the flow and set the Matrix server config on each matrix node.
+2. Replace the `@CHANGE_ME:example.org` / `CHANGE_ME` placeholders in the "Verify a user" inject nodes if you want to use the bot-initiated paths.
+3. To verify the bot from another client, start a verification with it, watch the debug sidebar for the `sas` event, compare the emoji, then click the **Confirm SAS match** inject.
+
+![device-verification-flow.png](device-verification-flow.png)
+
+</details>
+
+### Deprecated
+
+<details>
+<summary>Respond to "image" with an uploaded image</summary>
+
+[View JSON](respond-image-with-image.json)
+
+You will need an image on the machine running Node-RED. In this example, `example.png` exists inside the Node-RED directory.
+
+**Instructions:**
+
+1. Place the image file (`example.png`) in the appropriate directory.
+2. Import the flow and deploy it.
+
+![Respond to "image" with Uploaded Image](respond-image-with-image.png)
+
+</details>
+
+<details>
+<summary>Respond to "file" with an uploaded file</summary>
+
+[View JSON](respond-file-with-file.json)
+
+You will need a file on the machine running Node-RED. In this example, `sample.pdf` exists inside the Node-RED directory.
+
+**Instructions:**
+
+1. Place the file (`sample.pdf`) in the appropriate directory.
+2. Import the flow and deploy it.
+
+![Respond to "file" with Uploaded File](respond-file-with-file.png)
+
+</details>

examples/device-verification-flow.json

@@ -0,0 +1,548 @@
+[
+  {
+    "id": "7158964bd67edc52",
+    "type": "group",
+    "z": "vtest",
+    "name": "Example verification flow",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "40c105c38054d6db",
+      "83f785d52a61009a",
+      "d51bab8cbf5f247c",
+      "2e543533d49b467c"
+    ],
+    "x": 88,
+    "y": 73,
+    "w": 1044,
+    "h": 754
+  },
+  {
+    "id": "40c105c38054d6db",
+    "type": "group",
+    "z": "vtest",
+    "g": "7158964bd67edc52",
+    "name": "Verification request handling",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "mv_all",
+      "dbg_events",
+      "sw_phase",
+      "act_accept",
+      "act_start",
+      "chg_savevid",
+      "dbg_sas",
+      "dbg_done",
+      "dbg_cancelled",
+      "dbg_err"
+    ],
+    "x": 114,
+    "y": 99,
+    "w": 992,
+    "h": 342
+  },
+  {
+    "id": "mv_all",
+    "type": "matrix-verification",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "All verifications",
+    "server": null,
+    "phaseRequested": true,
+    "phaseReady": true,
+    "phaseStarted": true,
+    "phaseSas": true,
+    "phaseDone": true,
+    "phaseCancelled": true,
+    "initiatedBy": "any",
+    "verificationType": "any",
+    "selfVerification": "any",
+    "userFilter": "",
+    "roomFilter": "",
+    "x": 220,
+    "y": 180,
+    "wires": [
+      [
+        "dbg_events",
+        "sw_phase"
+      ]
+    ]
+  },
+  {
+    "id": "dbg_events",
+    "type": "debug",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "all verification events",
+    "active": true,
+    "tosidebar": true,
+    "complete": "true",
+    "x": 500,
+    "y": 140,
+    "wires": []
+  },
+  {
+    "id": "sw_phase",
+    "type": "switch",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "route by phase",
+    "property": "phase",
+    "propertyType": "msg",
+    "rules": [
+      {
+        "t": "eq",
+        "v": "requested",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "ready",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "sas",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "done",
+        "vt": "str"
+      },
+      {
+        "t": "eq",
+        "v": "cancelled",
+        "vt": "str"
+      }
+    ],
+    "checkall": "true",
+    "outputs": 5,
+    "x": 460,
+    "y": 220,
+    "wires": [
+      [
+        "act_accept"
+      ],
+      [
+        "act_start"
+      ],
+      [
+        "chg_savevid"
+      ],
+      [
+        "dbg_done"
+      ],
+      [
+        "dbg_cancelled"
+      ]
+    ]
+  },
+  {
+    "id": "act_accept",
+    "type": "matrix-verification-action",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "Accept",
+    "server": null,
+    "mode": "accept",
+    "x": 700,
+    "y": 180,
+    "wires": [
+      [],
+      [
+        "dbg_err"
+      ]
+    ]
+  },
+  {
+    "id": "act_start",
+    "type": "matrix-verification-action",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "Start SAS",
+    "server": null,
+    "mode": "start",
+    "x": 700,
+    "y": 230,
+    "wires": [
+      [],
+      [
+        "dbg_err"
+      ]
+    ]
+  },
+  {
+    "id": "chg_savevid",
+    "type": "change",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "save verificationId",
+    "rules": [
+      {
+        "t": "set",
+        "p": "verificationId",
+        "pt": "flow",
+        "to": "verificationId",
+        "tot": "msg"
+      }
+    ],
+    "x": 710,
+    "y": 290,
+    "wires": [
+      [
+        "dbg_sas"
+      ]
+    ]
+  },
+  {
+    "id": "dbg_sas",
+    "type": "debug",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "SAS emoji (msg.sas)",
+    "active": true,
+    "tosidebar": true,
+    "complete": "true",
+    "x": 960,
+    "y": 290,
+    "wires": []
+  },
+  {
+    "id": "dbg_done",
+    "type": "debug",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "verification done",
+    "active": true,
+    "tosidebar": true,
+    "complete": "true",
+    "x": 710,
+    "y": 350,
+    "wires": []
+  },
+  {
+    "id": "dbg_cancelled",
+    "type": "debug",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "verification cancelled",
+    "active": true,
+    "tosidebar": true,
+    "complete": "true",
+    "x": 730,
+    "y": 400,
+    "wires": []
+  },
+  {
+    "id": "dbg_err",
+    "type": "debug",
+    "z": "vtest",
+    "g": "40c105c38054d6db",
+    "name": "action errors",
+    "active": true,
+    "tosidebar": true,
+    "complete": "true",
+    "x": 940,
+    "y": 200,
+    "wires": []
+  },
+  {
+    "id": "83f785d52a61009a",
+    "type": "group",
+    "z": "vtest",
+    "g": "7158964bd67edc52",
+    "name": "Confirm or reject last verification request",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "inj_confirm",
+      "chg_vid_c",
+      "act_confirm",
+      "inj_reject",
+      "chg_vid_r",
+      "act_mismatch",
+      "dbg_result"
+    ],
+    "x": 114,
+    "y": 459,
+    "w": 982,
+    "h": 142
+  },
+  {
+    "id": "inj_confirm",
+    "type": "inject",
+    "z": "vtest",
+    "g": "83f785d52a61009a",
+    "name": "Confirm SAS match",
+    "props": [],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 250,
+    "y": 500,
+    "wires": [
+      [
+        "chg_vid_c"
+      ]
+    ]
+  },
+  {
+    "id": "chg_vid_c",
+    "type": "change",
+    "z": "vtest",
+    "g": "83f785d52a61009a",
+    "name": "verificationId from flow",
+    "rules": [
+      {
+        "t": "set",
+        "p": "verificationId",
+        "pt": "msg",
+        "to": "verificationId",
+        "tot": "flow"
+      }
+    ],
+    "x": 500,
+    "y": 500,
+    "wires": [
+      [
+        "act_confirm"
+      ]
+    ]
+  },
+  {
+    "id": "act_confirm",
+    "type": "matrix-verification-action",
+    "z": "vtest",
+    "g": "83f785d52a61009a",
+    "name": "Confirm SAS",
+    "server": null,
+    "mode": "confirm",
+    "x": 750,
+    "y": 500,
+    "wires": [
+      [
+        "dbg_result"
+      ],
+      [
+        "dbg_err"
+      ]
+    ]
+  },
+  {
+    "id": "inj_reject",
+    "type": "inject",
+    "z": "vtest",
+    "g": "83f785d52a61009a",
+    "name": "Reject SAS (mismatch)",
+    "props": [],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 260,
+    "y": 560,
+    "wires": [
+      [
+        "chg_vid_r"
+      ]
+    ]
+  },
+  {
+    "id": "chg_vid_r",
+    "type": "change",
+    "z": "vtest",
+    "g": "83f785d52a61009a",
+    "name": "verificationId from flow",
+    "rules": [
+      {
+        "t": "set",
+        "p": "verificationId",
+        "pt": "msg",
+        "to": "verificationId",
+        "tot": "flow"
+      }
+    ],
+    "x": 500,
+    "y": 560,
+    "wires": [
+      [
+        "act_mismatch"
+      ]
+    ]
+  },
+  {
+    "id": "act_mismatch",
+    "type": "matrix-verification-action",
+    "z": "vtest",
+    "g": "83f785d52a61009a",
+    "name": "Reject (mismatch)",
+    "server": null,
+    "mode": "mismatch",
+    "x": 760,
+    "y": 560,
+    "wires": [
+      [
+        "dbg_result"
+      ],
+      [
+        "dbg_err"
+      ]
+    ]
+  },
+  {
+    "id": "dbg_result",
+    "type": "debug",
+    "z": "vtest",
+    "g": "83f785d52a61009a",
+    "name": "action result",
+    "active": true,
+    "tosidebar": true,
+    "complete": "true",
+    "x": 980,
+    "y": 530,
+    "wires": []
+  },
+  {
+    "id": "d51bab8cbf5f247c",
+    "type": "group",
+    "z": "vtest",
+    "g": "7158964bd67edc52",
+    "name": "Request verification with specific user & device",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "inj_request",
+      "act_request"
+    ],
+    "x": 114,
+    "y": 619,
+    "w": 512,
+    "h": 82
+  },
+  {
+    "id": "inj_request",
+    "type": "inject",
+    "z": "vtest",
+    "g": "d51bab8cbf5f247c",
+    "name": "Verify a user & device",
+    "props": [
+      {
+        "p": "userId",
+        "v": "@CHANGE_ME:example.org",
+        "vt": "str"
+      },
+      {
+        "p": "deviceId",
+        "v": "CHANGE_ME",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 260,
+    "y": 660,
+    "wires": [
+      [
+        "act_request"
+      ]
+    ]
+  },
+  {
+    "id": "act_request",
+    "type": "matrix-verification-action",
+    "z": "vtest",
+    "g": "d51bab8cbf5f247c",
+    "name": "Request verification",
+    "server": null,
+    "mode": "request",
+    "x": 510,
+    "y": 660,
+    "wires": [
+      [
+        "dbg_result"
+      ],
+      [
+        "dbg_err"
+      ]
+    ]
+  },
+  {
+    "id": "2e543533d49b467c",
+    "type": "group",
+    "z": "vtest",
+    "g": "7158964bd67edc52",
+    "name": "Request verification with specific user & room",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "f7c043d39780b9a4",
+      "b2807fd5125b56b4"
+    ],
+    "x": 114,
+    "y": 719,
+    "w": 512,
+    "h": 82
+  },
+  {
+    "id": "f7c043d39780b9a4",
+    "type": "inject",
+    "z": "vtest",
+    "g": "2e543533d49b467c",
+    "name": "Verify a user & room",
+    "props": [
+      {
+        "p": "userId",
+        "v": "@CHANGE_ME:example.org",
+        "vt": "str"
+      },
+      {
+        "p": "topic",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "CHANGE_ME",
+    "x": 250,
+    "y": 760,
+    "wires": [
+      [
+        "b2807fd5125b56b4"
+      ]
+    ]
+  },
+  {
+    "id": "b2807fd5125b56b4",
+    "type": "matrix-verification-action",
+    "z": "vtest",
+    "g": "2e543533d49b467c",
+    "name": "Request verification",
+    "server": null,
+    "mode": "request",
+    "x": 510,
+    "y": 760,
+    "wires": [
+      [
+        "dbg_result"
+      ],
+      [
+        "dbg_err"
+      ]
+    ]
+  }
+]

examples/fetch-event-relations-aggregated.json

@@ -0,0 +1,141 @@
+[
+  {
+    "id": "10a897739618e1f3",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Aggregates paginated matrix event relations and outputs the full set after reaching the last page",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "83d9261d8fef6c29",
+      "c2e00e38bbeea60a",
+      "8c1df4f49b913bf8",
+      "4be02d632d13cebf",
+      "09fc3b3f18df27af"
+    ],
+    "x": 774,
+    "y": 939,
+    "w": 772,
+    "h": 142
+  },
+  {
+    "id": "83d9261d8fef6c29",
+    "type": "matrix-fetch-relations",
+    "z": "8fd89a0b44c61e76",
+    "g": "10a897739618e1f3",
+    "name": "",
+    "server": null,
+    "roomType": "msg",
+    "roomValue": "topic",
+    "eventIdType": "msg",
+    "eventIdValue": "eventId",
+    "relationTypeType": "json",
+    "relationTypeValue": "null",
+    "eventTypeType": "json",
+    "eventTypeValue": "null",
+    "directionType": "str",
+    "directionValue": "b",
+    "limitType": "json",
+    "limitValue": "null",
+    "recurseType": "bool",
+    "recurseValue": "false",
+    "fromType": "msg",
+    "fromValue": "payload.next_batch",
+    "toType": "json",
+    "toValue": "null",
+    "x": 1180,
+    "y": 1040,
+    "wires": [
+      [
+        "c2e00e38bbeea60a"
+      ],
+      [
+        "4be02d632d13cebf"
+      ]
+    ]
+  },
+  {
+    "id": "c2e00e38bbeea60a",
+    "type": "function",
+    "z": "8fd89a0b44c61e76",
+    "g": "10a897739618e1f3",
+    "name": "Loop - output on finish",
+    "func": "// you will want to use a unique flow_key \n// if you duplicate this node multiple times\nlet flow_key = \"relations_\" + msg.topic;\nlet relations = flow.get(flow_key) || [];\n\n// add our chunk to the flow variable\nrelations.push(...msg.payload.chunk);\n\nif(msg.payload.next_batch) {\n    // loop around for more records\n    flow.set(flow_key, relations);\n    return [null, msg];\n}\n\n// if msg.payload.next_batch is unset we have reached the end\nflow.set(flow_key, undefined);\nmsg.payload = relations;\nreturn [msg, null];",
+    "outputs": 2,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 1180,
+    "y": 980,
+    "wires": [
+      [
+        "8c1df4f49b913bf8"
+      ],
+      [
+        "83d9261d8fef6c29"
+      ]
+    ]
+  },
+  {
+    "id": "8c1df4f49b913bf8",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "10a897739618e1f3",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1420,
+    "y": 980,
+    "wires": []
+  },
+  {
+    "id": "4be02d632d13cebf",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "10a897739618e1f3",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1410,
+    "y": 1040,
+    "wires": []
+  },
+  {
+    "id": "09fc3b3f18df27af",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "10a897739618e1f3",
+    "name": "",
+    "props": [
+      {
+        "p": "topic",
+        "vt": "str"
+      },
+      {
+        "p": "eventId",
+        "v": "$example",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "!example:skylar.tech",
+    "x": 920,
+    "y": 1040,
+    "wires": [
+      [
+        "83d9261d8fef6c29"
+      ]
+    ]
+  }
+]

examples/get-event.json

@@ -0,0 +1,103 @@
+[
+  {
+    "id": "13e21fb561dd6367",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Get event by eventId and roomId",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "79aa7974c32c41e7",
+      "f895181928491647",
+      "687ab5804c6ab05c",
+      "c731a6923324de48"
+    ],
+    "x": 814,
+    "y": 759,
+    "w": 692,
+    "h": 122
+  },
+  {
+    "id": "79aa7974c32c41e7",
+    "type": "matrix-get-event",
+    "z": "8fd89a0b44c61e76",
+    "g": "13e21fb561dd6367",
+    "name": "",
+    "server": null,
+    "roomIdType": "msg",
+    "roomIdValue": "topic",
+    "eventIdType": "msg",
+    "eventIdValue": "eventId",
+    "x": 1200,
+    "y": 820,
+    "wires": [
+      [
+        "f895181928491647"
+      ],
+      [
+        "687ab5804c6ab05c"
+      ]
+    ]
+  },
+  {
+    "id": "f895181928491647",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "13e21fb561dd6367",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1380,
+    "y": 800,
+    "wires": []
+  },
+  {
+    "id": "687ab5804c6ab05c",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "13e21fb561dd6367",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1370,
+    "y": 840,
+    "wires": []
+  },
+  {
+    "id": "c731a6923324de48",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "13e21fb561dd6367",
+    "name": "",
+    "props": [
+      {
+        "p": "topic",
+        "vt": "str"
+      },
+      {
+        "p": "eventId",
+        "v": "$example",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "!example:skylar.tech",
+    "x": 960,
+    "y": 820,
+    "wires": [
+      [
+        "79aa7974c32c41e7"
+      ]
+    ]
+  }
+]

examples/get-set-displayname.json

@@ -0,0 +1,201 @@
+[
+  {
+    "id": "844cdfc6e3fc3207",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Get current display name",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "9807698e516450ec",
+      "3f700b2d3458a1e8",
+      "78ff7e5088a08ff6",
+      "0ae57f85687ba6b3"
+    ],
+    "x": 754,
+    "y": 2119,
+    "w": 612,
+    "h": 122
+  },
+  {
+    "id": "9807698e516450ec",
+    "type": "matrix-user-settings",
+    "z": "8fd89a0b44c61e76",
+    "g": "844cdfc6e3fc3207",
+    "name": "",
+    "server": null,
+    "roomId": null,
+    "rules": [
+      {
+        "t": "get",
+        "p": "display_name",
+        "to": "payload",
+        "tot": "msg",
+        "ls": true
+      }
+    ],
+    "x": 1020,
+    "y": 2180,
+    "wires": [
+      [
+        "78ff7e5088a08ff6"
+      ],
+      [
+        "0ae57f85687ba6b3"
+      ]
+    ]
+  },
+  {
+    "id": "3f700b2d3458a1e8",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "844cdfc6e3fc3207",
+    "name": "",
+    "props": [],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 850,
+    "y": 2180,
+    "wires": [
+      [
+        "9807698e516450ec"
+      ]
+    ]
+  },
+  {
+    "id": "78ff7e5088a08ff6",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "844cdfc6e3fc3207",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1240,
+    "y": 2160,
+    "wires": []
+  },
+  {
+    "id": "0ae57f85687ba6b3",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "844cdfc6e3fc3207",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1230,
+    "y": 2200,
+    "wires": []
+  },
+  {
+    "id": "289fac90afc8bfa6",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Set current display name",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "8f166980f4bfe6a4",
+      "c31399d30d9ea44f",
+      "c7984555f4ad668e",
+      "634935af5451baf9"
+    ],
+    "x": 754,
+    "y": 2259,
+    "w": 612,
+    "h": 122
+  },
+  {
+    "id": "8f166980f4bfe6a4",
+    "type": "matrix-user-settings",
+    "z": "8fd89a0b44c61e76",
+    "g": "289fac90afc8bfa6",
+    "name": "",
+    "server": null,
+    "roomId": null,
+    "rules": [
+      {
+        "t": "set",
+        "p": "display_name",
+        "to": "payload",
+        "tot": "msg"
+      }
+    ],
+    "x": 1020,
+    "y": 2320,
+    "wires": [
+      [
+        "c7984555f4ad668e"
+      ],
+      [
+        "634935af5451baf9"
+      ]
+    ]
+  },
+  {
+    "id": "c31399d30d9ea44f",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "289fac90afc8bfa6",
+    "name": "",
+    "props": [
+      {
+        "p": "payload"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "payload": "New Name",
+    "payloadType": "str",
+    "x": 860,
+    "y": 2320,
+    "wires": [
+      [
+        "8f166980f4bfe6a4"
+      ]
+    ]
+  },
+  {
+    "id": "c7984555f4ad668e",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "289fac90afc8bfa6",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1240,
+    "y": 2300,
+    "wires": []
+  },
+  {
+    "id": "634935af5451baf9",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "289fac90afc8bfa6",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1230,
+    "y": 2340,
+    "wires": []
+  }
+]

examples/get-user.json

@@ -0,0 +1,99 @@
+[
+  {
+    "id": "fdbc1eb4cc492b04",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Fetch user info by userId",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "8869afc68deeede0",
+      "e29636a733134aef",
+      "15c5caf17e83263c",
+      "52a65daa26891471"
+    ],
+    "x": 754,
+    "y": 1939,
+    "w": 552,
+    "h": 122
+  },
+  {
+    "id": "8869afc68deeede0",
+    "type": "matrix-get-user",
+    "z": "8fd89a0b44c61e76",
+    "g": "fdbc1eb4cc492b04",
+    "name": "",
+    "server": null,
+    "userType": "msg",
+    "userValue": "userId",
+    "propertyType": "msg",
+    "propertyValue": "user",
+    "x": 1000,
+    "y": 2000,
+    "wires": [
+      [
+        "15c5caf17e83263c"
+      ],
+      [
+        "52a65daa26891471"
+      ]
+    ]
+  },
+  {
+    "id": "e29636a733134aef",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "fdbc1eb4cc492b04",
+    "name": "",
+    "props": [
+      {
+        "p": "userId",
+        "v": "@skylord123:skylar.tech",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 850,
+    "y": 2000,
+    "wires": [
+      [
+        "8869afc68deeede0"
+      ]
+    ]
+  },
+  {
+    "id": "15c5caf17e83263c",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "fdbc1eb4cc492b04",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1180,
+    "y": 1980,
+    "wires": []
+  },
+  {
+    "id": "52a65daa26891471",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "fdbc1eb4cc492b04",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1170,
+    "y": 2020,
+    "wires": []
+  }
+]

examples/mark-all-read.json

@@ -0,0 +1,99 @@
+[
+  {
+    "id": "a8bd7a89b91a93c4",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Mark all received events as read",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "f9e49ebbc4bda431",
+      "c58fce26efb45b27",
+      "c8feb91421fcbbb3",
+      "e6d52159a6cfe0c0"
+    ],
+    "x": 754,
+    "y": 1579,
+    "w": 632,
+    "h": 122
+  },
+  {
+    "id": "f9e49ebbc4bda431",
+    "type": "matrix-mark-read",
+    "z": "8fd89a0b44c61e76",
+    "g": "a8bd7a89b91a93c4",
+    "name": "",
+    "server": null,
+    "roomType": "msg",
+    "roomValue": "topic",
+    "eventIdType": "msg",
+    "eventIdValue": "eventId",
+    "x": 1070,
+    "y": 1640,
+    "wires": [
+      [
+        "c8feb91421fcbbb3"
+      ],
+      [
+        "e6d52159a6cfe0c0"
+      ]
+    ]
+  },
+  {
+    "id": "c58fce26efb45b27",
+    "type": "matrix-receive",
+    "z": "8fd89a0b44c61e76",
+    "g": "a8bd7a89b91a93c4",
+    "name": "",
+    "server": null,
+    "roomId": "",
+    "acceptOwnEvents": false,
+    "acceptText": true,
+    "acceptEmotes": true,
+    "acceptStickers": true,
+    "acceptReactions": true,
+    "acceptFiles": true,
+    "acceptAudio": true,
+    "acceptImages": true,
+    "acceptVideos": true,
+    "acceptLocations": true,
+    "x": 860,
+    "y": 1640,
+    "wires": [
+      [
+        "f9e49ebbc4bda431"
+      ]
+    ]
+  },
+  {
+    "id": "c8feb91421fcbbb3",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "a8bd7a89b91a93c4",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1260,
+    "y": 1620,
+    "wires": []
+  },
+  {
+    "id": "e6d52159a6cfe0c0",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "a8bd7a89b91a93c4",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1250,
+    "y": 1660,
+    "wires": []
+  }
+]

examples/paginate-room-history.json

@@ -0,0 +1,173 @@
+[
+  {
+    "id": "1317b79375a65579",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Paginate the entire history of a given room",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "e8fc071b3f81fdee",
+      "33937ba1e74ed92d",
+      "4aadbf1c37d2ac8b",
+      "e4025b7df45f3d91",
+      "973dd418b00172c8",
+      "3edbea9403d7c347"
+    ],
+    "x": 854,
+    "y": 1339,
+    "w": 832,
+    "h": 182
+  },
+  {
+    "id": "e8fc071b3f81fdee",
+    "type": "matrix-paginate-room",
+    "z": "8fd89a0b44c61e76",
+    "g": "1317b79375a65579",
+    "name": "Paginate Room",
+    "server": null,
+    "roomType": "msg",
+    "roomValue": "topic",
+    "paginateKeyType": "msg",
+    "paginateKeyValue": "paginateKey",
+    "paginateBackwardsType": "msg",
+    "paginateBackwardsValue": "paginateBackwards",
+    "pageSizeType": "msg",
+    "pageSizeValue": "pageSize",
+    "x": 1280,
+    "y": 1480,
+    "wires": [
+      [
+        "973dd418b00172c8"
+      ],
+      [
+        "4aadbf1c37d2ac8b"
+      ]
+    ]
+  },
+  {
+    "id": "33937ba1e74ed92d",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "1317b79375a65579",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1560,
+    "y": 1380,
+    "wires": []
+  },
+  {
+    "id": "4aadbf1c37d2ac8b",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "1317b79375a65579",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1530,
+    "y": 1480,
+    "wires": []
+  },
+  {
+    "id": "e4025b7df45f3d91",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "1317b79375a65579",
+    "name": "",
+    "props": [
+      {
+        "p": "topic",
+        "vt": "str"
+      },
+      {
+        "p": "paginateKey",
+        "v": "",
+        "vt": "date"
+      },
+      {
+        "p": "paginateBackwards",
+        "v": "true",
+        "vt": "bool"
+      },
+      {
+        "p": "pageSize",
+        "v": "25",
+        "vt": "num"
+      },
+      {
+        "p": "timeout",
+        "v": "1000",
+        "vt": "num"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "!example:skylar.tech",
+    "x": 1000,
+    "y": 1480,
+    "wires": [
+      [
+        "e8fc071b3f81fdee"
+      ]
+    ]
+  },
+  {
+    "id": "973dd418b00172c8",
+    "type": "function",
+    "z": "8fd89a0b44c61e76",
+    "g": "1317b79375a65579",
+    "name": "Loop -  return each chunk",
+    "func": "node.status({\n    fill: \"green\",\n    text: `${msg.start} - ${msg.end} ${msg.payload ? '' : 'DONE'}`\n});\n\nif(msg.payload.length) {\n    // we have more records so output to both\n    return [msg, msg];\n}\n\n// no more records so only send to output 1\nreturn [msg, null];",
+    "outputs": 2,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 1290,
+    "y": 1400,
+    "wires": [
+      [
+        "33937ba1e74ed92d"
+      ],
+      [
+        "3edbea9403d7c347"
+      ]
+    ]
+  },
+  {
+    "id": "3edbea9403d7c347",
+    "type": "delay",
+    "z": "8fd89a0b44c61e76",
+    "g": "1317b79375a65579",
+    "name": "msg.delay",
+    "pauseType": "delayv",
+    "timeout": "0",
+    "timeoutUnits": "seconds",
+    "rate": "1",
+    "nbRateUnits": "1",
+    "rateUnits": "second",
+    "randomFirst": "1",
+    "randomLast": "5",
+    "randomUnits": "seconds",
+    "drop": false,
+    "allowrate": false,
+    "outputs": 1,
+    "x": 1550,
+    "y": 1420,
+    "wires": [
+      [
+        "e8fc071b3f81fdee"
+      ]
+    ]
+  }
+]

examples/send-image-to-room.json

@@ -0,0 +1,142 @@
+[
+  {
+    "id": "f4a0c2a9d7eed027",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Send an uploaded file to a room",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "8d475ab136d1ee7e",
+      "2524f5a9a7ea2444",
+      "9a149a36d6ab6470",
+      "9da1ed1dc33930bb",
+      "f93782c346d0e6ef"
+    ],
+    "x": 754,
+    "y": 2719,
+    "w": 992,
+    "h": 82
+  },
+  {
+    "id": "8d475ab136d1ee7e",
+    "type": "matrix-upload-file",
+    "z": "8fd89a0b44c61e76",
+    "g": "f4a0c2a9d7eed027",
+    "name": "",
+    "server": null,
+    "inputType": "msg",
+    "inputValue": "payload",
+    "fileNameType": "msg",
+    "fileNameValue": "filename",
+    "contentType": "",
+    "generateThumbnails": true,
+    "x": 1270,
+    "y": 2760,
+    "wires": [
+      [
+        "2524f5a9a7ea2444"
+      ],
+      []
+    ]
+  },
+  {
+    "id": "2524f5a9a7ea2444",
+    "type": "matrix-send-message",
+    "z": "8fd89a0b44c61e76",
+    "g": "f4a0c2a9d7eed027",
+    "name": "",
+    "server": null,
+    "roomId": "",
+    "message": "",
+    "messageType": "m.text",
+    "messageFormat": "",
+    "replaceMessage": false,
+    "threadReplyType": "msg",
+    "threadReplyValue": "isThread",
+    "x": 1440,
+    "y": 2760,
+    "wires": [
+      [
+        "f93782c346d0e6ef"
+      ],
+      []
+    ]
+  },
+  {
+    "id": "9a149a36d6ab6470",
+    "type": "http request",
+    "z": "8fd89a0b44c61e76",
+    "g": "f4a0c2a9d7eed027",
+    "name": "",
+    "method": "GET",
+    "ret": "bin",
+    "paytoqs": "ignore",
+    "url": "",
+    "tls": "",
+    "persist": false,
+    "proxy": "",
+    "insecureHTTPParser": false,
+    "authType": "",
+    "senderr": false,
+    "headers": [],
+    "x": 1110,
+    "y": 2760,
+    "wires": [
+      [
+        "8d475ab136d1ee7e"
+      ]
+    ]
+  },
+  {
+    "id": "9da1ed1dc33930bb",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "f4a0c2a9d7eed027",
+    "name": "",
+    "props": [
+      {
+        "p": "url",
+        "v": "https://nodered.org/about/resources/media/node-red-icon.png",
+        "vt": "str"
+      },
+      {
+        "p": "filename",
+        "v": "avatar.jpg",
+        "vt": "str"
+      },
+      {
+        "p": "topic",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "!example:skylar.tech",
+    "x": 900,
+    "y": 2760,
+    "wires": [
+      [
+        "9a149a36d6ab6470"
+      ]
+    ]
+  },
+  {
+    "id": "f93782c346d0e6ef",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "f4a0c2a9d7eed027",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1620,
+    "y": 2760,
+    "wires": []
+  }
+]

examples/set-avatar-from-url.json

@@ -0,0 +1,122 @@
+[
+  {
+    "id": "4cac7bbe81dd3a54",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Set new avatar image from remote image URL",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "91f08bf02decd653",
+      "44a586ebac1fb619",
+      "d3bd4a0d4e1520a3",
+      "e9e591def93615c5"
+    ],
+    "x": 754,
+    "y": 2419,
+    "w": 712,
+    "h": 82
+  },
+  {
+    "id": "91f08bf02decd653",
+    "type": "http request",
+    "z": "8fd89a0b44c61e76",
+    "g": "4cac7bbe81dd3a54",
+    "name": "",
+    "method": "GET",
+    "ret": "bin",
+    "paytoqs": "ignore",
+    "url": "",
+    "tls": "",
+    "persist": false,
+    "proxy": "",
+    "insecureHTTPParser": false,
+    "authType": "",
+    "senderr": false,
+    "headers": [],
+    "x": 1010,
+    "y": 2460,
+    "wires": [
+      [
+        "e9e591def93615c5"
+      ]
+    ]
+  },
+  {
+    "id": "44a586ebac1fb619",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "4cac7bbe81dd3a54",
+    "name": "",
+    "props": [
+      {
+        "p": "url",
+        "v": "https://nodered.org/about/resources/media/node-red-icon.png",
+        "vt": "str"
+      },
+      {
+        "p": "filename",
+        "v": "avatar.jpg",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "",
+    "x": 850,
+    "y": 2460,
+    "wires": [
+      [
+        "91f08bf02decd653"
+      ]
+    ]
+  },
+  {
+    "id": "d3bd4a0d4e1520a3",
+    "type": "matrix-user-settings",
+    "z": "8fd89a0b44c61e76",
+    "g": "4cac7bbe81dd3a54",
+    "name": "",
+    "server": null,
+    "roomId": null,
+    "rules": [
+      {
+        "t": "set",
+        "p": "avatar_url",
+        "to": "payload.url",
+        "tot": "msg"
+      }
+    ],
+    "x": 1360,
+    "y": 2460,
+    "wires": [
+      [],
+      []
+    ]
+  },
+  {
+    "id": "e9e591def93615c5",
+    "type": "matrix-upload-file",
+    "z": "8fd89a0b44c61e76",
+    "g": "4cac7bbe81dd3a54",
+    "name": "",
+    "server": null,
+    "inputType": "msg",
+    "inputValue": "payload",
+    "fileNameType": "msg",
+    "fileNameValue": "filename",
+    "contentType": "",
+    "generateThumbnails": true,
+    "x": 1190,
+    "y": 2460,
+    "wires": [
+      [
+        "d3bd4a0d4e1520a3"
+      ],
+      []
+    ]
+  }
+]

examples/set-room-name-and-topic.json

@@ -0,0 +1,120 @@
+[
+  {
+    "id": "2e2bb3f8521150c0",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Set room name and topic",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "610648ad6bd73072",
+      "aca9be4e86e111f3",
+      "7f5e16c4f6c7885f",
+      "915ce202570af51a"
+    ],
+    "x": 674,
+    "y": 2539,
+    "w": 732,
+    "h": 122
+  },
+  {
+    "id": "610648ad6bd73072",
+    "type": "matrix-room-state-events",
+    "z": "8fd89a0b44c61e76",
+    "g": "2e2bb3f8521150c0",
+    "name": "",
+    "server": null,
+    "roomType": "msg",
+    "roomValue": "topic",
+    "rules": [
+      {
+        "t": "set",
+        "p": "m.room.name",
+        "to": "roomName",
+        "tot": "msg"
+      },
+      {
+        "t": "set",
+        "p": "m.room.topic",
+        "to": "description",
+        "tot": "msg"
+      }
+    ],
+    "x": 1050,
+    "y": 2600,
+    "wires": [
+      [
+        "7f5e16c4f6c7885f"
+      ],
+      [
+        "915ce202570af51a"
+      ]
+    ]
+  },
+  {
+    "id": "aca9be4e86e111f3",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "2e2bb3f8521150c0",
+    "name": "",
+    "props": [
+      {
+        "p": "topic",
+        "vt": "str"
+      },
+      {
+        "p": "roomName",
+        "v": "Test Room",
+        "vt": "str"
+      },
+      {
+        "p": "description",
+        "v": "This is a test room for my Node-RED bot",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "!example:skylar.tech",
+    "x": 820,
+    "y": 2600,
+    "wires": [
+      [
+        "610648ad6bd73072"
+      ]
+    ]
+  },
+  {
+    "id": "7f5e16c4f6c7885f",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "2e2bb3f8521150c0",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1280,
+    "y": 2580,
+    "wires": []
+  },
+  {
+    "id": "915ce202570af51a",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "2e2bb3f8521150c0",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1270,
+    "y": 2620,
+    "wires": []
+  }
+]

examples/view-event-relations.json

@@ -0,0 +1,141 @@
+[
+  {
+    "id": "ab09dd64e9c48bba",
+    "type": "group",
+    "z": "8fd89a0b44c61e76",
+    "name": "Pages through matrix event relations, delivering results one page at a time",
+    "style": {
+      "label": true
+    },
+    "nodes": [
+      "ed98bce4958c4203",
+      "501758e233cc42d9",
+      "edb9af1a22e2e17f",
+      "4734e9ee26fe0812",
+      "fc27f2058f9c934b"
+    ],
+    "x": 754,
+    "y": 1139,
+    "w": 892,
+    "h": 142
+  },
+  {
+    "id": "ed98bce4958c4203",
+    "type": "matrix-fetch-relations",
+    "z": "8fd89a0b44c61e76",
+    "g": "ab09dd64e9c48bba",
+    "name": "",
+    "server": null,
+    "roomType": "msg",
+    "roomValue": "topic",
+    "eventIdType": "msg",
+    "eventIdValue": "eventId",
+    "relationTypeType": "json",
+    "relationTypeValue": "null",
+    "eventTypeType": "json",
+    "eventTypeValue": "null",
+    "directionType": "str",
+    "directionValue": "b",
+    "limitType": "json",
+    "limitValue": "null",
+    "recurseType": "bool",
+    "recurseValue": "false",
+    "fromType": "msg",
+    "fromValue": "payload.next_batch",
+    "toType": "json",
+    "toValue": "null",
+    "x": 1280,
+    "y": 1240,
+    "wires": [
+      [
+        "edb9af1a22e2e17f"
+      ],
+      [
+        "fc27f2058f9c934b"
+      ]
+    ]
+  },
+  {
+    "id": "501758e233cc42d9",
+    "type": "inject",
+    "z": "8fd89a0b44c61e76",
+    "g": "ab09dd64e9c48bba",
+    "name": "",
+    "props": [
+      {
+        "p": "topic",
+        "vt": "str"
+      },
+      {
+        "p": "eventId",
+        "v": "$example",
+        "vt": "str"
+      }
+    ],
+    "repeat": "",
+    "crontab": "",
+    "once": false,
+    "onceDelay": 0.1,
+    "topic": "!example:skylar.tech",
+    "x": 900,
+    "y": 1240,
+    "wires": [
+      [
+        "ed98bce4958c4203"
+      ]
+    ]
+  },
+  {
+    "id": "edb9af1a22e2e17f",
+    "type": "function",
+    "z": "8fd89a0b44c61e76",
+    "g": "ab09dd64e9c48bba",
+    "name": "Loop -  return each chunk",
+    "func": "if(msg.payload.next_batch) {\n    // we have more records so output to both\n    return [msg, msg];\n}\n\n// no more records so only send to output 1\nreturn [msg, null];",
+    "outputs": 2,
+    "noerr": 0,
+    "initialize": "",
+    "finalize": "",
+    "libs": [],
+    "x": 1290,
+    "y": 1180,
+    "wires": [
+      [
+        "4734e9ee26fe0812"
+      ],
+      [
+        "ed98bce4958c4203"
+      ]
+    ]
+  },
+  {
+    "id": "4734e9ee26fe0812",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "ab09dd64e9c48bba",
+    "name": "Debug Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1520,
+    "y": 1180,
+    "wires": []
+  },
+  {
+    "id": "fc27f2058f9c934b",
+    "type": "debug",
+    "z": "8fd89a0b44c61e76",
+    "g": "ab09dd64e9c48bba",
+    "name": "Error Output",
+    "active": true,
+    "tosidebar": true,
+    "console": false,
+    "tostatus": false,
+    "complete": "true",
+    "x": 1510,
+    "y": 1240,
+    "wires": []
+  }
+]

package.json

@@ -1,20 +1,20 @@
 {
   "name": "node-red-contrib-matrix-chat",
-  "version": "0.8.0",
+  "version": "1.0.0",
   "description": "Matrix chat server client for Node-RED",
   "dependencies": {
     "abort-controller": "^3.0.0",
+    "fake-indexeddb": "^6.2.5",
     "fluent-ffmpeg": "^2.1.2",
     "fs-extra": "^11.1.0",
     "got": "^12.0.2",
     "image-size": "^1.0.2",
     "isomorphic-webcrypto": "^2.3.8",
-    "matrix-js-sdk": "^28.0.0",
+    "matrix-js-sdk": "^41.5.0",
     "mime": "^3.0.0",
     "node-fetch": "^3.3.0",
     "node-localstorage": "^2.2.1",
-    "olm": "https://gitlab.matrix.org/matrix-org/olm/-/package_files/2572/download",
-    "request": "^2.88.2",
+    "sharp": "^0.33.4",
     "tmp": "^0.2.1",
     "utf8": "^3.0.0"
   },
@@ -49,11 +49,15 @@
       "matrix-synapse-deactivate-user": "src/matrix-synapse-deactivate-user.js",
       "matrix-synapse-join-room": "src/matrix-synapse-join-room.js",
       "matrix-whois-user": "src/matrix-whois-user.js",
-      "matrix-paginate-room": "src/matrix-paginate-room.js"
+      "matrix-paginate-room": "src/matrix-paginate-room.js",
+      "matrix-get-event": "src/matrix-get-event.js",
+      "matrix-event-relations": "src/matrix-event-relations.js",
+      "matrix-verification": "src/matrix-verification.js",
+      "matrix-verification-action": "src/matrix-verification-action.js"
     }
   },
   "engines": {
-    "node": ">=14.0.0"
+    "node": ">=22.0.0"
   },
   "keywords": [
     "node-red",
@@ -64,7 +68,7 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/skylar-tech/node-red-contrib-matrix-chat"
+    "url": "git+https://github.com/Skylar-Tech/node-red-contrib-matrix-chat.git"
   },
   "author": {
     "name": "Skylar Sadlier",

src/matrix-crypt-file.html

@@ -43,6 +43,16 @@
             <span class="property-type">string | null</span>
         </dt>
         <dd> the decoded mxc url.</dd>
+
+        <dt class="optional">msg.headers
+            <span class="property-type">object</span>
+        </dt>
+        <dd>optional HTTP headers. If provided, they are used when downloading media (for example authenticated media bearer tokens).</dd>
+
+        <dt class="optional">msg.access_token
+            <span class="property-type">string</span>
+        </dt>
+        <dd>optional Matrix access token. Used as a bearer token if <code>msg.headers.Authorization</code> is not present.</dd>
     </dl>
 
     <h3>Outputs</h3>
@@ -74,4 +84,4 @@
     <ul>
         <li><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME Types</a> - description of <code>msg.contentType</code> format</li>
     </ul>
-</script>
+</script>

src/matrix-crypt-file.js

@@ -32,7 +32,9 @@ module.exports = function(RED) {
             }
 
             try{
-                let buffer = await got(msg.url).buffer();
+                const requestOptions = getRequestOptions(msg);
+
+                let buffer = await downloadBufferWithFallback(got, msg.url, requestOptions);
                 msg.payload = Buffer.from(await decryptAttachment(buffer, msg.content.file));
 
                 // handle thumbnail decryption if necessary
@@ -41,13 +43,14 @@ module.exports = function(RED) {
                     && msg.thumbnail_url
                     && msg.content.info.thumbnail_file
                 ) {
-                    let thumb_buffer = await got(msg.thumbnail_url).buffer();
+                    let thumb_buffer = await downloadBufferWithFallback(got, msg.thumbnail_url, requestOptions);
                     msg.thumbnail_payload = Buffer.from(await decryptAttachment(thumb_buffer, msg.content.info.thumbnail_file));
                 }
             } catch(error){
                 node.error(error);
                 msg.error = error;
                 node.send([null, msg]);
+                return;
             }
 
             msg.filename = msg.content.filename || msg.content.body;
@@ -57,12 +60,58 @@ module.exports = function(RED) {
     }
     RED.nodes.registerType("matrix-decrypt-file", MatrixDecryptFile);
 
+    function getRequestOptions(msg) {
+        const headers = { ...(msg.headers || {}) };
+        if (!headers.Authorization && msg.access_token) {
+            headers.Authorization = `Bearer ${msg.access_token}`;
+        }
+
+        return Object.keys(headers).length ? { headers } : {};
+    }
+
+    function getMediaEndpointFallbackUrl(url) {
+        if (typeof url !== "string") {
+            return null;
+        }
+
+        if (url.includes("/_matrix/media/v3/download/")) {
+            return url.replace("/_matrix/media/v3/download/", "/_matrix/client/v1/media/download/");
+        }
+
+        if (url.includes("/_matrix/client/v1/media/download/")) {
+            return url.replace("/_matrix/client/v1/media/download/", "/_matrix/media/v3/download/");
+        }
+
+        if (url.includes("/_matrix/media/v3/thumbnail/")) {
+            return url.replace("/_matrix/media/v3/thumbnail/", "/_matrix/client/v1/media/thumbnail/");
+        }
+
+        if (url.includes("/_matrix/client/v1/media/thumbnail/")) {
+            return url.replace("/_matrix/client/v1/media/thumbnail/", "/_matrix/media/v3/thumbnail/");
+        }
+
+        return null;
+    }
+
+    async function downloadBufferWithFallback(got, url, requestOptions) {
+        try {
+            return await got(url, requestOptions).buffer();
+        } catch (error) {
+            const fallbackUrl = getMediaEndpointFallbackUrl(url);
+            if (error?.response?.statusCode === 404 && fallbackUrl && fallbackUrl !== url) {
+                return await got(fallbackUrl, requestOptions).buffer();
+            }
+
+            throw error;
+        }
+    }
+
     function atob(a) {
-        return new Buffer.from(a, 'base64').toString('binary');
+        return Buffer.from(a, 'base64').toString('binary');
     }
 
     function btoa(b) {
-        return new Buffer.from(b).toString('base64');
+        return Buffer.from(b).toString('base64');
     }
 
     // the following was taken & modified from https://github.com/matrix-org/browser-encrypt-attachment/blob/master/index.js
@@ -200,4 +249,4 @@ module.exports = function(RED) {
         }
         return uint8Array;
     }
-}
+}

src/matrix-crypto-store.js

@@ -0,0 +1,175 @@
+/**
+ * Persistence helpers for the matrix-js-sdk Rust crypto store in Node.js.
+ *
+ * matrix-js-sdk v37+ removed the legacy (libolm) crypto stack. The Rust crypto
+ * replacement persists its state (device identity, Olm/megolm sessions, etc.)
+ * to IndexedDB, which does not exist in Node.js. We provide an in-memory
+ * IndexedDB via `fake-indexeddb` and snapshot the databases to/from disk so the
+ * crypto state survives Node-RED restarts.
+ *
+ * The `indexeddbshim` package (which can persist to disk directly) is not used
+ * because it is incompatible with the Rust crypto store migrations
+ * (see matrix-org/matrix-sdk-crypto-wasm#195). `fake-indexeddb` is spec
+ * compliant, so snapshotting it through the public IndexedDB API is reliable.
+ */
+const fs = require('fs-extra');
+const v8 = require('v8');
+
+let shimInstalled = false;
+
+/**
+ * Install the in-memory IndexedDB shim onto globalThis. Idempotent. Must be
+ * called before MatrixClient.initRustCrypto().
+ */
+function ensureIndexedDBShim() {
+    if (shimInstalled || globalThis.indexedDB) {
+        shimInstalled = true;
+        return;
+    }
+    // `fake-indexeddb/auto` assigns indexedDB / IDBKeyRange / etc. onto globalThis.
+    require('fake-indexeddb/auto');
+    shimInstalled = true;
+}
+
+function reqAsync(req) {
+    return new Promise((resolve, reject) => {
+        req.onsuccess = () => resolve(req.result);
+        req.onerror = () => reject(req.error);
+    });
+}
+
+function txDone(tx) {
+    return new Promise((resolve, reject) => {
+        tx.oncomplete = () => resolve();
+        tx.onerror = () => reject(tx.error);
+        tx.onabort = () => reject(tx.error || new Error('IndexedDB transaction aborted'));
+    });
+}
+
+/**
+ * Restore previously snapshotted IndexedDB databases from `filePath` into the
+ * in-memory store. No-op if the snapshot does not exist. Databases that are
+ * already present in memory (e.g. after a Node-RED redeploy that kept the
+ * process alive) are left untouched so the live state is not clobbered.
+ *
+ * Must be called before MatrixClient.initRustCrypto().
+ *
+ * @returns {Promise<boolean>} true if at least one database was restored.
+ */
+async function restoreCryptoStore(filePath) {
+    ensureIndexedDBShim();
+
+    if (!filePath || !fs.pathExistsSync(filePath)) {
+        return false;
+    }
+
+    let databases;
+    try {
+        databases = v8.deserialize(fs.readFileSync(filePath));
+    } catch (e) {
+        // Corrupt/unreadable snapshot - start fresh rather than crash.
+        return false;
+    }
+    if (!Array.isArray(databases) || !databases.length) {
+        return false;
+    }
+
+    const existing = new Set((await indexedDB.databases()).map((d) => d.name));
+    let restored = 0;
+
+    for (const dbSpec of databases) {
+        if (existing.has(dbSpec.name)) {
+            continue; // already live in memory - don't overwrite
+        }
+
+        const openReq = indexedDB.open(dbSpec.name, dbSpec.version);
+        openReq.onupgradeneeded = () => {
+            const db = openReq.result;
+            for (const store of dbSpec.stores) {
+                if (db.objectStoreNames.contains(store.name)) {
+                    continue;
+                }
+                const os = db.createObjectStore(store.name, {
+                    keyPath: store.keyPath || undefined,
+                    autoIncrement: store.autoIncrement,
+                });
+                for (const ix of store.indexes) {
+                    os.createIndex(ix.name, ix.keyPath, { unique: ix.unique, multiEntry: ix.multiEntry });
+                }
+            }
+        };
+        const db = await reqAsync(openReq);
+
+        for (const store of dbSpec.stores) {
+            if (!store.values.length) {
+                continue;
+            }
+            const tx = db.transaction(store.name, 'readwrite');
+            const os = tx.objectStore(store.name);
+            for (let i = 0; i < store.values.length; i++) {
+                if (store.keyPath) {
+                    os.put(store.values[i]);
+                } else {
+                    os.put(store.values[i], store.keys[i]);
+                }
+            }
+            await txDone(tx);
+        }
+        db.close();
+        restored++;
+    }
+
+    return restored > 0;
+}
+
+/**
+ * Snapshot IndexedDB databases to `filePath`. If `dbNamePrefix` is given only
+ * databases whose name starts with it are written, so multiple Matrix accounts
+ * sharing one process do not snapshot each other's data.
+ *
+ * The write is atomic (temp file + rename). Values are serialized with the V8
+ * serializer so typed arrays / Maps inside the crypto store survive intact.
+ *
+ * @returns {Promise<boolean>} true if a snapshot file was written.
+ */
+async function snapshotCryptoStore(filePath, dbNamePrefix) {
+    if (!filePath || !globalThis.indexedDB || typeof indexedDB.databases !== 'function') {
+        return false;
+    }
+
+    let dbList = await indexedDB.databases();
+    if (dbNamePrefix) {
+        dbList = dbList.filter((d) => typeof d.name === 'string' && d.name.startsWith(dbNamePrefix));
+    }
+
+    const out = [];
+    for (const { name, version } of dbList) {
+        const db = await reqAsync(indexedDB.open(name, version));
+        const stores = [];
+        for (const storeName of Array.from(db.objectStoreNames)) {
+            const tx = db.transaction(storeName, 'readonly');
+            const os = tx.objectStore(storeName);
+            const indexes = Array.from(os.indexNames).map((n) => {
+                const ix = os.index(n);
+                return { name: n, keyPath: ix.keyPath, unique: ix.unique, multiEntry: ix.multiEntry };
+            });
+            stores.push({
+                name: storeName,
+                keyPath: os.keyPath,
+                autoIncrement: os.autoIncrement,
+                indexes,
+                values: await reqAsync(os.getAll()),
+                keys: await reqAsync(os.getAllKeys()),
+            });
+        }
+        db.close();
+        out.push({ name, version, stores });
+    }
+
+    const tmp = `${filePath}.tmp`;
+    fs.writeFileSync(tmp, v8.serialize(out));
+    fs.renameSync(tmp, filePath);
+    return true;
+}
+
+module.exports = { ensureIndexedDBShim, restoreCryptoStore, snapshotCryptoStore };

src/matrix-event-relations.html

@@ -0,0 +1,230 @@
+<script type="text/javascript">
+    RED.nodes.registerType('matrix-fetch-relations', {
+        category: 'matrix',
+        color: '#00b7ca',
+        icon: "matrix.png",
+        outputLabels: ["Related Events", "Error"],
+        inputs: 1,
+        outputs: 2,
+        defaults: {
+            name: { value: null },
+            server: { type: "matrix-server-config" },
+            roomType: { value: "msg" },
+            roomValue: { value: "topic" },
+            eventIdType: { value: "msg" },
+            eventIdValue: { value: "eventId" },
+            relationTypeType: { value: "json" },
+            relationTypeValue: { value: "null" },
+            eventTypeType: { value: "json" },
+            eventTypeValue: { value: "null" },
+            directionType: { value: "str" },
+            directionValue: { value: "b" },
+            limitType: { value: "json" },
+            limitValue: { value: "null" },
+            recurseType: { value: "bool" },
+            recurseValue: { value: "false" },
+            fromType: { value: "msg" },
+            fromValue: { value: "payload.next_batch" },
+            toType: { value: "json" },
+            toValue: { value: "null" },
+        },
+        label: function () {
+            return this.name || "Fetch Event Relations";
+        },
+        paletteLabel: 'Fetch Event Relations',
+        oneditprepare: function () {
+            $("#node-input-room").typedInput({
+                type: this.roomType,
+                types: ['msg', 'flow', 'global', 'str'],
+            })
+                .typedInput('value', this.roomValue)
+                .typedInput('type', this.roomType);
+
+            $("#node-input-eventId").typedInput({
+                types: ['msg', 'flow', 'global', 'str'],
+            })
+                .typedInput('value', this.eventIdValue)
+                .typedInput('type', this.eventIdType);
+
+            $("#node-input-relationType").typedInput({
+                types: ['msg', 'flow', 'global', 'str', 'json'],
+            })
+                .typedInput('value', this.relationTypeValue)
+                .typedInput('type', this.relationTypeType);
+
+            $("#node-input-eventType").typedInput({
+                types: ['msg', 'flow', 'global', 'str', 'json'],
+            })
+                .typedInput('value', this.eventTypeValue)
+                .typedInput('type', this.eventTypeType);
+
+            $("#node-input-direction").typedInput({
+                types: ['msg', 'flow', 'global', 'str'],
+            })
+                .typedInput('value', this.directionValue)
+                .typedInput('type', this.directionType);
+
+            $("#node-input-limit").typedInput({
+                types: ['msg', 'flow', 'global', 'num', 'json'],
+            })
+                .typedInput('value', this.limitValue)
+                .typedInput('type', this.limitType);
+
+            $("#node-input-recurse").typedInput({
+                types: ['msg', 'flow', 'global', 'bool', 'json'],
+            })
+                .typedInput('value', this.recurseValue)
+                .typedInput('type', this.recurseType);
+
+            $("#node-input-from").typedInput({
+                types: ['msg', 'flow', 'global', 'str', 'json'],
+            })
+                .typedInput('value', this.fromValue)
+                .typedInput('type', this.fromType);
+
+            $("#node-input-to").typedInput({
+                types: ['msg', 'flow', 'global', 'str', 'json'],
+            })
+                .typedInput('value', this.toValue)
+                .typedInput('type', this.toType);
+        },
+        oneditsave: function () {
+            this.roomType = $("#node-input-room").typedInput('type');
+            this.roomValue = $("#node-input-room").typedInput('value');
+            this.eventIdType = $("#node-input-eventId").typedInput('type');
+            this.eventIdValue = $("#node-input-eventId").typedInput('value');
+            this.relationTypeType = $("#node-input-relationType").typedInput('type');
+            this.relationTypeValue = $("#node-input-relationType").typedInput('value');
+            this.eventTypeType = $("#node-input-eventType").typedInput('type');
+            this.eventTypeValue = $("#node-input-eventType").typedInput('value');
+            this.directionType = $("#node-input-direction").typedInput('type');
+            this.directionValue = $("#node-input-direction").typedInput('value');
+            this.limitType = $("#node-input-limit").typedInput('type');
+            this.limitValue = $("#node-input-limit").typedInput('value');
+            this.recurseType = $("#node-input-recurse").typedInput('type');
+            this.recurseValue = $("#node-input-recurse").typedInput('value');
+            this.fromType = $("#node-input-from").typedInput('type');
+            this.fromValue = $("#node-input-from").typedInput('value');
+            this.toType = $("#node-input-to").typedInput('type');
+            this.toValue = $("#node-input-to").typedInput('value');
+        }
+    });
+</script>
+
+<script type="text/html" data-template-name="matrix-fetch-relations">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-server"></i> Matrix Server</label>
+        <input type="text" id="node-input-server">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-room"><i class="fa fa-comments"></i> Room</label>
+        <input type="text" id="node-input-room">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-eventId"><i class="fa fa-key"></i> Event ID</label>
+        <input type="text" id="node-input-eventId">
+        <div class="form-tips" style="margin-top: 10px;">The event ID for which relations are being fetched.</div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-relationType"><i class="fa fa-link"></i> Relation Type</label>
+        <input type="text" id="node-input-relationType">
+        <div class="form-tips" style="margin-top: 10px;">The type of relations (e.g., m.in_reply_to, m.replace, m.annotation, m.thread, m.reference) to be fetched for the event. You can read more in the <a href="https://spec.matrix.org/v1.11/client-server-api/#relationship-types" target="_blank">Matrix specification</a>.</div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-eventType"><i class="fa fa-file"></i> Event Type</label>
+        <input type="text" id="node-input-eventType">
+        <div class="form-tips" style="margin-top: 10px;">The type of event (e.g., m.reaction, m.annotation) to be retrieved.</div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-direction"><i class="fa fa-arrow-left"></i> Direction</label>
+        <input type="text" id="node-input-direction">
+        <div class="form-tips" style="margin-top: 10px;">Set the direction of pagination. Can be "b" for backwards or "f" for forwards. Defaults to "b".</div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-limit"><i class="fa fa-arrow-left"></i> Limit</label>
+        <input type="text" id="node-input-limit">
+        <div class="form-tips" style="margin-top: 10px;">The maximum number of results to return in a single chunk. Recommended to leave as null to use the server default.</div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-recurse"><i class="fa fa-arrow-left"></i> Recurse</label>
+        <input type="text" id="node-input-recurse">
+        <div class="form-tips" style="margin-top: 10px;">
+            Whether to additionally include events which only relate indirectly to the given event, i.e. events related to the given event via two or more direct relationships.
+            <br><br>
+            If set to false, only events which have a direct relation with the given event will be included.
+            <br><br>
+            If set to true, events which have an indirect relation with the given event will be included additionally up to a certain depth level. Homeservers SHOULD traverse at least 3 levels of relationships. Implementations MAY perform more but MUST be careful to not infinitely recurse.
+            <br><br>
+            The default value is false.
+            <br><br>
+            Added in v1.10
+        </div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-from"><i class="fa fa-arrow-left"></i> From</label>
+        <input type="text" id="node-input-from">
+        <div class="form-tips" style="margin-top: 10px;">
+            The pagination token to start returning results from. If not supplied, results start at the most recent topological event known to the server.
+            <br><br>
+            Can be a next_batch or prev_batch token from a previous call, or a returned start token from /messages, or a next_batch token from /sync.
+            <br><br>
+            Defaults to msg.payload.next_batch to easily fetch the next batch in a recursive loop.
+        </div>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-to"><i class="fa fa-arrow-left"></i> To</label>
+        <input type="text" id="node-input-to">
+        <div class="form-tips" style="margin-top: 10px;">
+            The pagination token to stop returning results at. If not supplied, results continue up to limit or until there are no more events.
+            <br><br>
+            Like from, this can be a previous token from a prior call to this endpoint or from /messages or /sync.
+        </div>
+    </div>
+</script>
+
+<script type="text/html" data-help-name="matrix-fetch-relations">
+    <p>
+        The Matrix Fetch Relations node allows you to retrieve event relations for a specific event within a Matrix room.
+    </p>
+
+    <h3>Inputs</h3>
+    <ul>
+        <li><strong>msg</strong> (<em>default</em>): Triggers the fetching of relations based on the provided parameters.</li>
+    </ul>
+
+    <h3>Outputs</h3>
+    <ul>
+        <li>
+            <strong>Output 1 (Related Events)</strong>: Returns an array of events with their relations.
+            Each event contains details such as:
+            <ul>
+                <li><code>msg.payload.chunk</code> - Array of related events.</li>
+                <li><code>msg.payload.prev_batch</code> - The previous batch token for pagination.</li>
+                <li><code>msg.payload.next_batch</code> - The next batch token for pagination.</li>
+            </ul>
+        </li>
+        <li>
+            <strong>Output 2 (Error)</strong>: If an error occurs during the fetch process, the error message is sent to this output.
+        </li>
+    </ul>
+
+    <h3>Dynamic Properties</h3>
+    <p>Properties such as <strong>Room ID</strong>, <strong>Event ID</strong>, <strong>Relation Type</strong>, and <strong>Event Type</strong> can be dynamically set using message, flow, or global context variables.</p>
+
+    <h3>Usage</h3>
+    <p>To fetch event relations, trigger this node with a <code>msg</code> input. The node will fetch the relations for the given event ID and return the related events.</p>
+</script>

src/matrix-event-relations.js

@@ -0,0 +1,111 @@
+const sdkPromise = import("matrix-js-sdk");
+
+module.exports = function(RED) {
+    function MatrixFetchRelations(n) {
+        RED.nodes.createNode(this, n);
+
+        let node = this;
+        this.name = n.name;
+        this.server = RED.nodes.getNode(n.server);
+        this.roomType = n.roomType;
+        this.roomValue = n.roomValue;
+        this.eventIdType = n.eventIdType;
+        this.eventIdValue = n.eventIdValue;
+        this.relationTypeType = n.relationTypeType;
+        this.relationTypeValue = n.relationTypeValue;
+        this.eventTypeType = n.eventTypeType;
+        this.eventTypeValue = n.eventTypeValue;
+        this.directionType = n.directionType;
+        this.directionValue = n.directionValue;
+        this.limitType = n.limitType;
+        this.limitValue = n.limitValue;
+        this.recurseType = n.recurseType;
+        this.recurseValue = n.recurseValue;
+        this.fromType = n.fromType;
+        this.fromValue = n.fromValue;
+        this.toType = n.toType;
+        this.toValue = n.toValue;
+
+        node.status({ fill: "red", shape: "ring", text: "disconnected" });
+
+        if (!node.server) {
+            node.error("No configuration node", {});
+            return;
+        }
+        node.server.register(node);
+
+        node.server.on("disconnected", function() {
+            node.status({ fill: "red", shape: "ring", text: "disconnected" });
+        });
+
+        node.server.on("connected", function() {
+            node.status({ fill: "green", shape: "ring", text: "connected" });
+        });
+
+        node.on("input", async function(msg) {
+            if (!node.server || !node.server.matrixClient) {
+                node.error("No matrix server selected", msg);
+                return;
+            }
+
+            try {
+                const sdk = await sdkPromise;
+                const Direction = sdk.Direction;
+
+                function evaluateNodePropertySafe(value, type, node, msg) {
+                    try {
+                        return RED.util.evaluateNodeProperty(value, type, node, msg);
+                    } catch (e) {
+                        if (e instanceof TypeError) {
+                            return undefined;
+                        }
+                        throw e;
+                    }
+                }
+
+                let roomId = RED.util.evaluateNodeProperty(node.roomValue, node.roomType, node, msg),
+                    eventId = RED.util.evaluateNodeProperty(node.eventIdValue, node.eventIdType, node, msg),
+                    relationType = RED.util.evaluateNodeProperty(node.relationTypeValue, node.relationTypeType, node, msg),
+                    eventType = RED.util.evaluateNodeProperty(node.eventTypeValue, node.eventTypeType, node, msg),
+                    direction = RED.util.evaluateNodeProperty(node.directionValue, node.directionType, node, msg) || Direction.Backward,
+                    limit = RED.util.evaluateNodeProperty(node.limitValue, node.limitType, node, msg),
+                    recurse = RED.util.evaluateNodeProperty(node.recurseValue, node.recurseType, node, msg),
+                    from = evaluateNodePropertySafe(node.fromValue, node.fromType, node, msg),
+                    to = evaluateNodePropertySafe(node.toValue, node.toType, node, msg);
+
+                let opts = { dir: direction };
+                if (limit) {
+                    opts.limit = limit;
+                }
+                if (recurse === true || recurse === false) {
+                    opts.recurse = recurse;
+                }
+                if (from) {
+                    opts.from = from;
+                }
+                if (to) {
+                    opts.to = to;
+                }
+
+                msg.payload = await node.server.matrixClient.fetchRelations(
+                    roomId,
+                    eventId,
+                    relationType || null,
+                    eventType || null,
+                    opts
+                );
+                node.send([msg, null]);
+            } catch (e) {
+                msg.error = `Event relations pagination error: ${e.stack}`;
+                node.error(msg.error, msg);
+                node.send([null, msg]);
+            }
+        });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
+    }
+
+    RED.nodes.registerType("matrix-fetch-relations", MatrixFetchRelations);
+};

src/matrix-get-event.html

@@ -0,0 +1,95 @@
+<script type="text/javascript">
+    RED.nodes.registerType('matrix-get-event',{
+        category: 'matrix',
+        color: '#00b7ca',
+        icon: "matrix.png",
+        outputLabels: ["success", "error"],
+        inputs: 1,
+        outputs: 2,
+        defaults: {
+            name: { value: null },
+            server: { type: "matrix-server-config" },
+            roomIdType: { value: "msg" },
+            roomIdValue: { value: "topic" },
+            eventIdType: { value: "msg" },
+            eventIdValue: { value: "eventId" }
+        },
+        label: function() {
+            return this.name || "Get Event";
+        },
+        oneditprepare: function() {
+            $("#node-input-roomId").typedInput({
+                types: ['msg','flow','global','str'],
+                typeField: "#node-input-roomId"
+            });
+            $("#node-input-roomId").typedInput("type", this.roomIdType || "msg");
+            $("#node-input-roomId").typedInput("value", this.roomIdValue || "topic");
+
+            $("#node-input-eventId").typedInput({
+                types: ['msg','flow','global','str'],
+                typeField: "#node-input-eventId"
+            });
+            $("#node-input-eventId").typedInput("type", this.eventIdType || "msg");
+            $("#node-input-eventId").typedInput("value", this.eventIdValue || "eventId");
+        },
+        oneditsave: function() {
+            this.roomIdType = $("#node-input-roomId").typedInput('type');
+            this.roomIdValue = $("#node-input-roomId").typedInput('value');
+            this.eventIdType = $("#node-input-eventId").typedInput('type');
+            this.eventIdValue = $("#node-input-eventId").typedInput('value');
+        },
+        paletteLabel: 'Get Event'
+    });
+</script>
+
+<script type="text/html" data-template-name="matrix-get-event">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-user"></i> Matrix Server Config</label>
+        <input type="text" id="node-input-server">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-roomId"><i class="fa fa-file"></i> Room ID</label>
+        <input type="text" id="node-input-roomId">
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-eventId"><i class="fa fa-file"></i> Event ID</label>
+        <input type="text" id="node-input-eventId">
+    </div>
+</script>
+
+<script type="text/html" data-help-name="matrix-get-event">
+    <h3>Details</h3>
+    <p>Get an event from a Matrix room using the Room ID and Event ID. Returns the event object as the payload.</p>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt>msg.payload.roomId <span class="property-type">string</span></dt>
+        <dd>The Room ID from which the event will be fetched.</dd>
+
+        <dt>msg.payload.eventId <span class="property-type">string</span></dt>
+        <dd>The Event ID of the message to fetch.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+        <li>Success
+            <dl class="message-properties">
+                <dt>msg.payload <span class="property-type">object</span></dt>
+                <dd>The fetched event object.</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>msg.payload <span class="property-type">string</span></dt>
+                <dd>Error details.</dd>
+            </dl>
+        </li>
+    </ol>
+</script>

src/matrix-get-event.js

@@ -0,0 +1,87 @@
+module.exports = function(RED) {
+    function MatrixGetEvent(n) {
+        RED.nodes.createNode(this, n);
+
+        let node = this;
+
+        this.name = n.name;
+        this.server = RED.nodes.getNode(n.server);
+        this.roomIdType = n.roomIdType;
+        this.roomIdValue = n.roomIdValue;
+        this.eventIdType = n.eventIdType;
+        this.eventIdValue = n.eventIdValue;
+
+        node.status({ fill: "red", shape: "ring", text: "disconnected" });
+
+        if (!node.server) {
+            node.error("No configuration node", {});
+            return;
+        }
+        node.server.register(node);
+
+        node.server.on("disconnected", function(){
+            node.status({ fill: "red", shape: "ring", text: "disconnected" });
+        });
+
+        node.server.on("connected", function() {
+            node.status({ fill: "green", shape: "ring", text: "connected" });
+        });
+
+        node.on('input', async function(msg) {
+            if (! node.server || ! node.server.matrixClient) {
+                node.error("No matrix server selected", msg);
+                node.send([null, msg]);
+                return;
+            }
+
+            if (!node.server.isConnected()) {
+                node.error("Matrix server connection is currently closed", msg);
+                node.send([null, msg]);
+                return;
+            }
+
+            function getToValue(msg, type, property) {
+                let value = property;
+                if (type === "msg") {
+                    value = RED.util.getMessageProperty(msg, property);
+                } else if ((type === 'flow') || (type === 'global')) {
+                    try {
+                        value = RED.util.evaluateNodeProperty(property, type, node, msg);
+                    } catch(e2) {
+                        throw new Error("Invalid value evaluation");
+                    }
+                } else if(type === "bool") {
+                    value = (property === 'true');
+                } else if(type === "num") {
+                    value = Number(property);
+                }
+                return value;
+            }
+
+            try {
+                let roomId = getToValue(msg, node.roomIdType, node.roomIdValue),
+                    eventId = getToValue(msg, node.eventIdType, node.eventIdValue);
+
+                if(!roomId) {
+                    node.error('Missing roomId', msg);
+                    return;
+                } else if(!eventId) {
+                    node.error('Missing eventId', msg);
+                    return;
+                }
+
+                msg.payload = await node.server.matrixClient.fetchRoomEvent(roomId, eventId);
+                node.send([msg, null]);
+            } catch(e) {
+                node.error("Failed to get event " + msg.topic + ": " + e, msg);
+                msg.payload = e;
+                node.send([null, msg]);
+            }
+        });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
+    }
+    RED.nodes.registerType("matrix-get-event", MatrixGetEvent);
+}

src/matrix-get-user.html

@@ -12,25 +12,19 @@
         <input type="text" id="node-input-user">
     </div>
     <div class="form-row">
-        <label for="node-input-property"><i class="fa fa-user"></i> Property</label>
+        <label for="node-input-property"><i class="fa fa-user"></i> Output Property</label>
         <input type="text" id="node-input-property">
     </div>
     <div class="form-row form-tips">
         This is the property the user data object will be set to
     </div>
-    <div class="form-row" style="margin-bottom:0;">
-        <label><i class="fa fa-list"></i> <span data-i18n="change.label.rules"></span></label>
-    </div>
-    <div class="form-row node-input-rule-container-row">
-        <ol id="node-input-rule-container"></ol>
-    </div>
 
 </script>
 
 <script type="text/html" data-help-name="matrix-get-user">
     <h3>Details</h3>
     <p>
-        Get data for a user. Data includes display name, avatar URL, presence, last active, currently active, and latest user events.
+        Get data for a user. Data includes display name, avatar URL, presence, last active, currently active, and latest user events. You must share a room with the user. This tried to fetch the user from local storage and if it does not exist will then ask the server.
     </p>
 
     <h3>Inputs</h3>
@@ -62,27 +56,6 @@
 
 <script type="text/javascript">
     (function(){
-        var roomEventTypeOptions = [
-            { value: "m.room.name", label: "m.room.name" },
-            { value: "m.room.topic", label: "m.room.topic" },
-            { value: "m.room.avatar", label: "m.room.avatar" },
-            { value: "m.room.power_levels", label: "m.room.power_levels" },
-            { value: "m.room.guest_access", label: "m.room.guest_access" },
-            { value: "m.room.join_rules", label: "m.room.join_rules" },
-            { value: "m.room.canonical_alias", label: "m.room.canonical_alias" },
-            { value: "m.room.history_visibility", label: "m.room.history_visibility" },
-            { value: "m.room.server_acl", label: "m.room.server_acl" },
-            { value: "m.room.pinned_events", label: "m.room.pinned_events"},
-            { value: "m.space.child", label: "m.space.child" },
-            { value: "m.space.parent", label: "m.space.parent" },
-        ];
-        var defaultRules = [{
-            t: "set",
-            p: roomEventTypeOptions[0].value,
-            to: "payload",
-            tot: "msg"
-        }];
-
         function isInvalidProperty(v,vt) {
             if (/msg|flow|global/.test(vt)) {
                 if (!RED.utils.validatePropertyExpression(v)) {
@@ -129,208 +102,12 @@
                 })
                     .typedInput('value', this.propertyValue)
                     .typedInput('type', this.propertyType);
-
-                var set = "Set";
-                var to = "to the value";
-                var toValueLabel = "to the property";
-                var search = this._("change.action.search");
-                var replace = this._("change.action.replace");
-                var regex = this._("change.label.regex");
-
-                function createPropertyValue(row2_1, row2_2, type, defaultType) {
-                    var propValInput = $('<input/>',{class:"node-input-rule-property-value",type:"text"})
-                        .appendTo(row2_1)
-                        .typedInput({
-                            default: defaultType || (type === 'set' ? 'str' : 'msg'),
-                            types: (type === 'set' ? ['msg','flow','global','str','json','jsonata'] : ['msg', 'flow', 'global'])
-                        });
-
-                    var lsLabel = $('<label style="padding-left: 130px;"></label>').appendTo(row2_2);
-                    var localStorageEl = $('<input type="checkbox" class="node-input-rule-property-localStorage" style="width: auto; margin: 0 6px 0 0">').appendTo(lsLabel);
-                    $('<span>').text("Fetch from local storage").appendTo(lsLabel);
-
-                    propValInput.on("change", function(evt,type,val) {
-                        row2_2.toggle(type === "msg" || type === "flow" || type === "global" || type === "env");
-                    })
-                    return [propValInput, localStorageEl];
-                }
-
-                $('#node-input-rule-container').css('min-height','150px').css('min-width','450px').editableList({
-                    addItem: function(container,i,opt) {
-                        var rule = opt;
-                        if (!rule.hasOwnProperty('t')) {
-                            rule = {t:"set",p:roomEventTypeOptions[0].value,to:"payload",tot:"msg"};
-                        }
-                        if (rule.t === "set" && !rule.tot) {
-                            if (rule.to.indexOf("msg.") === 0 && !rule.tot) {
-                                rule.to = rule.to.substring(4);
-                                rule.tot = "msg";
-                            } else {
-                                rule.tot = "str";
-                            }
-                        }
-                        container.css({
-                            overflow: 'hidden',
-                            whiteSpace: 'nowrap'
-                        });
-                        let fragment = document.createDocumentFragment();
-                        var row1 = $('<div/>',{style:"display:flex; align-items: center"}).appendTo(fragment);
-                        var row2 = $('<div/>',{style:"margin-top:8px;"}).appendTo(fragment);
-                        var row3 = $('<div/>',{style:"margin-top:8px;"}).appendTo(fragment);
-                        var row4 = $('<div/>',{style:"display:flex;margin-top:8px;align-items: baseline"}).appendTo(fragment);
-
-                        var selectField = $('<select/>',{class:"node-input-rule-type",style:"width:110px; margin-right:10px;"}).appendTo(row1);
-                        var selectOptions = [
-                            {v:"set",l:"Set"},
-                            {v:"get",l:"Get"}
-                        ];
-                        for (var x=0; x<selectOptions.length; x++) {
-                            selectField.append($("<option></option>").val(selectOptions[x].v).text(selectOptions[x].l));
-                        }
-
-                        var propertyName = $('<input/>',{class:"node-input-rule-property-name",type:"text"})
-                            .appendTo(row1)
-                            .autoComplete({
-                                minLength:0,
-                                search: function(val) {
-                                    if(!val) {
-                                        return roomEventTypeOptions.sort(function(A,B){return A.i-B.i});
-                                    }
-                                    var matches = [];
-                                    roomEventTypeOptions.map((x) => x.value).forEach(v => {
-                                        var i = v.toLowerCase().indexOf(val.toLowerCase());
-                                        if (i > -1) {
-                                            matches.push({
-                                                value: v,
-                                                label: v,
-                                                i: i
-                                            })
-                                        }
-                                    });
-                                    matches.sort(function(A,B){return A.i-B.i})
-                                    return matches
-                                }
-                            })
-                            .on('focus', function(evt){
-                                // following is a fix so autocomplete will show list on focus
-                                if(!evt.isTrigger) {
-                                    evt.stopPropagation();
-                                    $(this).trigger("keyup.red-ui-autoComplete");
-                                }
-                            }).on("keyup", function(evt) {
-                                // following allows autocomplete to display even when backspace/delete is used
-                                if (evt.keyCode === 8 || evt.keyCode === 46) {
-                                    evt.stopPropagation();
-                                    $(this).trigger("keyup.red-ui-autoComplete");
-                                }
-                            });
-
-                        var row2_1 = $('<div/>', {style:"display:flex;align-items: baseline"}).appendTo(row2);
-                        $('<div/>',{style:"display:inline-block;text-align:right; width:120px; padding-right:10px; box-sizing:border-box;"})
-                            .text(toValueLabel)
-                            .appendTo(row2_1);
-
-                        var row2_2 = $('<div/>', {style:"margin-top: 4px;"}).appendTo(row2);
-
-                        var row3_1 = $('<div/>', {style:"display:flex;align-items: baseline"}).appendTo(row3);
-                        $('<div/>',{style:"display:inline-block;text-align:right; width:120px; padding-right:10px; box-sizing:border-box;"})
-                            .text(search)
-                            .appendTo(row3_1);
-
-                        var row3_2 = $('<div/>',{style:"display:flex;margin-top:8px;align-items: baseline"}).appendTo(row3);
-                        $('<div/>',{style:"display:inline-block;text-align:right; width:120px; padding-right:10px; box-sizing:border-box;"})
-                            .text(replace)
-                            .appendTo(row3_2);
-
-                        $('<div/>',{style:"display:inline-block;text-align:right; width:120px; padding-right:10px; box-sizing:border-box;"})
-                            .text(to)
-                            .appendTo(row4);
-
-                        let propertyValue = null;
-                        let localStorageEl = null;
-                        let fromValue = null;
-                        let toValue = null;
-
-                        selectField.on("change", function() {
-                            var type = $(this).val();
-                            if (propertyValue) {
-                                propertyValue.typedInput('hide');
-                            }
-                            if (fromValue) {
-                                fromValue.typedInput('hide');
-                            }
-                            if (toValue) {
-                                toValue.typedInput('hide');
-                            }
-
-                            if (!propertyValue) {
-                                var parts = createPropertyValue(row2_1, row2_2, type);
-                                propertyValue = parts[0];
-                                localStorageEl = parts[1];
-                            } else {
-                                propertyValue.typedInput('types', (type === 'set' ? ['msg','flow','global','str','json','jsonata'] : ['msg', 'flow', 'global']));
-                            }
-
-                            propertyValue.typedInput('show');
-                            row2.show();
-                            if(type === 'get') {
-                                localStorageEl.parent().show();
-                            } else {
-                                localStorageEl.parent().hide();
-                            }
-                            row3.hide();
-                            row4.hide();
-                        });
-
-                        selectField.val(rule.t);
-                        propertyName.val(rule.p);
-                        if (rule.t === "set" || rule.t === "get") {
-                            var parts = createPropertyValue(row2_1, row2_2, rule.t, rule.tot);
-                            propertyValue = parts[0];
-                            localStorageEl = parts[1];
-                            propertyValue.typedInput('value',rule.to);
-                            localStorageEl.prop("checked", !!rule.ls);
-                            if(rule.t === 'get') {
-                                localStorageEl.parent().show();
-                            } else {
-                                localStorageEl.parent().hide();
-                            }
-                        }
-                        selectField.change();
-                        container[0].appendChild(fragment);
-                    },
-                    removable: true,
-                    sortable: true
-                });
-
-                for (var i=0; i<this.rules.length; i++) {
-                    var rule = this.rules[i];
-                    $("#node-input-rule-container").editableList('addItem',rule);
-                }
             },
             oneditsave: function() {
                 this.userType = $("#node-input-user").typedInput('type');
                 this.userValue = $("#node-input-user").typedInput('value');
                 this.propertyType = $("#node-input-property").typedInput('type');
                 this.propertyValue = $("#node-input-property").typedInput('value');
-                var rules = $("#node-input-rule-container").editableList('items');
-                var node = this;
-                node.rules= [];
-                rules.each(function(i) {
-                    var rule = $(this);
-                    var type = rule.find(".node-input-rule-type").val();
-                    var r = {
-                        t:type,
-                        p:rule.find(".node-input-rule-property-name").val(),
-                        to:rule.find(".node-input-rule-property-value").typedInput('value'),
-                        tot:rule.find(".node-input-rule-property-value").typedInput('type')
-                    };
-
-                    if (r.t === "get" && rule.find(".node-input-rule-property-localStorage").prop("checked")) {
-                        r.ls = true;
-                    }
-                    node.rules.push(r);
-                });
             },
             oneditresize: function(size) {
                 var rows = $("#dialog-form>div:not(.node-input-rule-container-row)");

src/matrix-get-user.js

@@ -106,14 +106,14 @@ module.exports = function(RED) {
                 let user2 = {};
 
                 try {
-                    let profileInfo = node.server.matrixClient.getProfileInfo(userId);
-                    if(Object.keys(profileInfo).length > 0) {
+                    let profileInfo = await node.server.matrixClient.getProfileInfo(userId);
+                    if(profileInfo && Object.keys(profileInfo).length > 0) {
                         user2.displayName = profileInfo.displayname;
                         user2.avatarUrl = profileInfo.avatar_url;
                     }
 
-                    let presence = node.server.matrixClient.getPresence(userId);
-                    if(Object.keys(presence).length > 0) {
+                    let presence = await node.server.matrixClient.getPresence(userId);
+                    if(presence && Object.keys(presence).length > 0) {
                         user2.currentlyActive = presence.currently_active;
                         user2.lastActiveAgo = presence.last_active_ago;
                         user2.presenceStatusMsg = presence.presence_status_msg;

src/matrix-invite-room.js

@@ -54,9 +54,10 @@ module.exports = function(RED) {
                 return;
             }
 
-            // we need the status code, so set onlydata to false for this request
+            // invite(roomId, userId, opts|reason) - the SDK no longer accepts a
+            // callback argument, so the reason is passed as the 3rd parameter.
             node.server.matrixClient
-                .invite(msg.topic, msg.userId, undefined, msg.reason || undefined)
+                .invite(msg.topic, msg.userId, msg.reason || undefined)
                 .then(function(e){
                     msg.payload = e;
                     node.send([msg, null]);

src/matrix-mark-read.html

@@ -64,191 +64,35 @@
 </script>
 
 <script type="text/html" data-help-name="matrix-mark-read">
-    <p>Mark an event in a room as read.</p>
+    <p>This node marks an event in a Matrix room as read.</p>
 
-    <h3>Outputs</h3>
-    <ul class="node-ports">
-        <li>Always Returned
+    <h3>Inputs</h3>
+    <ul class="message-properties">
+        <li>The input message (<code>msg</code>) should contain the following values, which can be configured to read from different properties:
             <dl class="message-properties">
-                <dt>msg.type <span class="property-type">string</span></dt>
-                <dd>
-                    the message type. For example this will be either m.text, m.reaction, m.file, m.image, etc
-                </dd>
-            </dl>
+                <dt>Room ID</dt>
+                <dd>The ID of the room where the event resides. By default, this is read from <code>msg.topic</code>, but it can be configured to read from any property via a typed input.</dd>
 
-            <dl class="message-properties">
-                <dt>msg.isDM <span class="property-type">bool</span></dt>
-                <dd> returns true if message is from a direct message room.</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.encrypted <span class="property-type">bool</span></dt>
-                <dd> returns true if message was encrypted (e2ee).</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.redacted <span class="property-type">bool</span></dt>
-                <dd> returns true if the message was redacted (such as deleted by the user).</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.payload <span class="property-type">string</span></dt>
-                <dd>the body from the message's content.</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.userId <span class="property-type">string</span></dt>
-                <dd>the User ID of the message sender. Example: @john:matrix.org</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.topic <span class="property-type">string</span></dt>
-                <dd>the ID of the room. Example: !OGEhHVWSdvArJzumhm:matrix.org</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.event <span class="property-type">object</span></dt>
-                <dd>the event object returned by the Matrix server</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.eventId <span class="property-type">object</span></dt>
-                <dd>The event ID, e.g. $143350589368169JsLZx:localhost</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.content <span class="property-type">object</span></dt>
-                <dd>the message's content object</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.text</strong>'
-            <div class="form-tips" style="margin-bottom: 12px;">
-                Doesn't return anything extra
-            </div>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.reaction</strong>'
-            <dl class="message-properties">
-                <dt>msg.referenceEventId <span class="property-type">string</span></dt>
-                <dd>the message that the reaction relates to</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.payload <span class="property-type">string</span></dt>
-                <dd>the key of the reaction's content</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.emote</strong>'
-            <div class="form-tips" style="margin-bottom: 12px;">
-                Doesn't return anything extra
-            </div>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.sticker</strong>'
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>URL to the sticker image</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>Matrix URL to the sticker image</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_url <span class="property-type">string</span></dt>
-                <dd>URL to the thumbnail of the sticker</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_mxc_url <span class="property-type">string</span></dt>
-                <dd>Matrix URL to the thumbnail of the sticker</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.file</strong>'
-            <dl class="message-properties">
-                <dt>msg.filename <span class="property-type">string</span></dt>
-                <dd>the file's parsed filename</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>the file's URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>the file's Matrix URL</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.audio</strong>'
-            <dl class="message-properties">
-                <dt>msg.filename <span class="property-type">string</span></dt>
-                <dd>the image's parsed filename</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mimetype <span class="property-type">string</span></dt>
-                <dd>audio file mimetype (ex: audio/ogg)</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>the file's URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>the file's Matrix URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.duration <span class="property-type">integer</span></dt>
-                <dd>duration of audio file in milliseconds</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.waveform <span class="property-type">array[int]</span></dt>
-                <dd>waveform of the audio clip</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.image</strong>'
-            <dl class="message-properties">
-                <dt>msg.filename <span class="property-type">string</span></dt>
-                <dd>the image's parsed filename</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>the image's URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>the image's Matrix URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_url <span class="property-type">string</span></dt>
-                <dd>the image's thumbnail URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_mxc_url <span class="property-type">string</span></dt>
-                <dd>the image's thumbnail Matrix URL</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.location</strong>'
-            <dl class="message-properties">
-                <dt>msg.geo_uri <span class="property-type">string</span></dt>
-                <dd>URI format of the geolocation</dd>
+                <dt>Event ID</dt>
+                <dd>The event ID you want to mark as read. By default, this is read from <code>msg.eventId</code>, but it can be configured to read from any property via a typed input.</dd>
             </dl>
         </li>
     </ul>
-</script>
+
+    <h3>Outputs</h3>
+    <ul class="node-ports">
+        <li>Output 1 (Success):
+            <ul>
+                <li>Triggered when the event is successfully marked as read.</li>
+            </ul>
+        </li>
+        <li>Output 2 (Failure):
+            <ul>
+                <li>Triggered when there is an error marking the event as read. An error message will be included in <code>msg.error</code>.</li>
+            </ul>
+        </li>
+    </ul>
+
+    <h3>Usage</h3>
+    <p>This node dynamically reads the room ID and event ID from the message or other properties using typed inputs, allowing you to configure where the values are sourced from. It retrieves the corresponding event and sends a "read" receipt to the Matrix server to mark the event as read. If successful, it will trigger the first output. If an error occurs (e.g., the event or room is not found), the second output is triggered with the error message.</p>
+</script>

src/matrix-mark-read.js

@@ -1,9 +1,8 @@
-const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
 const crypto = require('crypto');
-module.exports = function(RED) {
-    function MatrixReceiveMessage(n) {
-        RED.nodes.createNode(this, n);
 
+module.exports = function(RED) {
+    function MatrixMarkRead(n) {
+        RED.nodes.createNode(this, n);
         let node = this;
         this.name = n.name;
         this.server = RED.nodes.getNode(n.server);
@@ -29,7 +28,7 @@ module.exports = function(RED) {
         });
 
         node.on("input", async function (msg) {
-            if (! node.server || ! node.server.matrixClient) {
+            if (!node.server || !node.server.matrixClient) {
                 node.error("No matrix server selected", msg);
                 return;
             }
@@ -38,15 +37,15 @@ module.exports = function(RED) {
                 let value = property;
                 if (type === "msg") {
                     value = RED.util.getMessageProperty(msg, property);
-                } else if ((type === 'flow') || (type === 'global')) {
+                } else if (type === 'flow' || type === 'global') {
                     try {
                         value = RED.util.evaluateNodeProperty(property, type, node, msg);
-                    } catch(e2) {
+                    } catch (e2) {
                         throw new Error("Invalid value evaluation");
                     }
-                } else if(type === "bool") {
+                } else if (type === "bool") {
                     value = (property === 'true');
-                } else if(type === "num") {
+                } else if (type === "num") {
                     value = Number(property);
                 }
                 return value;
@@ -56,9 +55,19 @@ module.exports = function(RED) {
                 let roomId = getToValue(msg, node.roomType, node.roomValue),
                     eventId = getToValue(msg, node.eventIdType, node.eventIdValue);
 
-                msg.payload = await node.server.matrixClient.setRoomReadMarkers(roomId, eventId);
+                const room = node.server.matrixClient.getRoom(roomId);
+                if (!room) {
+                    throw new Error(`Room ${roomId} not found.`);
+                }
+
+                const event = room.findEventById(eventId);
+                if (!event) {
+                    throw new Error(`Event ${eventId} not found in room ${roomId}.`);
+                }
+
+                await node.server.matrixClient.sendReceipt(event, "m.read");
                 node.send([msg, null]);
-            } catch(e) {
+            } catch (e) {
                 msg.error = `Room pagination error: ${e}`;
                 node.error(msg.error, msg);
                 node.send([null, msg]);
@@ -69,5 +78,5 @@ module.exports = function(RED) {
             node.server.deregister(node);
         });
     }
-    RED.nodes.registerType("matrix-mark-read", MatrixReceiveMessage);
-}
+    RED.nodes.registerType("matrix-mark-read", MatrixMarkRead);
+}

src/matrix-paginate-room.html

@@ -1,9 +1,9 @@
 <script type="text/javascript">
-    RED.nodes.registerType('matrix-paginate-room',{
+    RED.nodes.registerType('matrix-paginate-room', {
         category: 'matrix',
         color: '#00b7ca',
         icon: "matrix.png",
-        outputLabels: ["message"],
+        outputLabels: ["Paginated Data", "Error"],
         inputs: 1,
         outputs: 2,
         defaults: {
@@ -18,37 +18,37 @@
             pageSizeType: { value: "num" },
             pageSizeValue: { value: "25" }
         },
-        label: function() {
+        label: function () {
             return this.name || "Paginate Room";
         },
         paletteLabel: 'Paginate Room',
-        oneditprepare: function() {
+        oneditprepare: function () {
             $("#node-input-room").typedInput({
                 type: this.roomType,
-                types:['msg','flow','global','str'],
+                types: ['msg', 'flow', 'global', 'str'],
             })
                 .typedInput('value', this.roomValue)
                 .typedInput('type', this.roomType);
 
             $("#node-input-paginateBackwards").typedInput({
-                types:['msg','flow','global','bool'],
+                types: ['msg', 'flow', 'global', 'bool'],
             })
                 .typedInput('value', this.paginateBackwardsValue)
                 .typedInput('type', this.paginateBackwardsType);
 
             $("#node-input-paginateKey").typedInput({
-                types:['msg','flow','global'],
+                types: ['msg', 'flow', 'global'],
             })
                 .typedInput('value', this.paginateKeyValue)
                 .typedInput('type', this.paginateKeyType);
 
             $("#node-input-pageSize").typedInput({
-                types:['msg','flow','global','num'],
+                types: ['msg', 'flow', 'global', 'num'],
             })
                 .typedInput('value', this.pageSizeValue)
                 .typedInput('type', this.pageSizeType);
         },
-        oneditsave: function() {
+        oneditsave: function () {
             this.roomType = $("#node-input-room").typedInput('type');
             this.roomValue = $("#node-input-room").typedInput('value');
             this.paginateBackwardsType = $("#node-input-paginateBackwards").typedInput('type');
@@ -78,207 +78,56 @@
     </div>
 
     <div class="form-row">
-        <label for="node-input-paginateKey"><i class="fa fa-comments"></i> Pagination Key</label>
+        <label for="node-input-paginateKey"><i class="fa fa-key"></i> Pagination Key</label>
         <input type="text" id="node-input-paginateKey">
+        <div class="form-tips" style="margin-top: 10px;">A unique key to identify the current pagination session. If not provided, a new key will be generated for each session.</div>
     </div>
 
     <div class="form-row">
-        <label for="node-input-paginateBackwards"><i class="fa fa-commenting-o"></i> Paginate Backwards</label>
+        <label for="node-input-paginateBackwards"><i class="fa fa-arrow-left"></i> Paginate Backwards</label>
         <input type="text" id="node-input-paginateBackwards">
+        <div class="form-tips" style="margin-top: 10px;">Set to true to paginate backwards (older events). Set to false to paginate forwards (newer events).</div>
     </div>
 
     <div class="form-row">
-        <label for="node-input-pageSize"><i class="fa fa-commenting-o"></i> Page Size</label>
+        <label for="node-input-pageSize"><i class="fa fa-list"></i> Page Size</label>
         <input type="text" id="node-input-pageSize">
+        <div class="form-tips" style="margin-top: 10px;">Set the number of events to retrieve per pagination call. It's recommended to keep this value at or below 25 to match the current initial synchronization limit. Adjust this based on your server’s load and capacity to avoid throttling or performance issues.</div>
     </div>
 </script>
 
 <script type="text/html" data-help-name="matrix-paginate-room">
-    <p>Receive events from Matrix.</p>
+    <p>
+        The Matrix Paginate Room node allows you to retrieve historical or future events from a Matrix room, moving forwards or backwards through the event timeline.
+    </p>
+
+    <h3>Inputs</h3>
+    <ul>
+        <li><strong>msg</strong> (<em>default</em>): Triggers the pagination action based on the provided room and parameters.</li>
+    </ul>
 
     <h3>Outputs</h3>
-    <ul class="node-ports">
-        <li>Always Returned
-            <dl class="message-properties">
-                <dt>msg.type <span class="property-type">string</span></dt>
-                <dd>
-                    the message type. For example this will be either m.text, m.reaction, m.file, m.image, etc
-                </dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.isDM <span class="property-type">bool</span></dt>
-                <dd> returns true if message is from a direct message room.</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.encrypted <span class="property-type">bool</span></dt>
-                <dd> returns true if message was encrypted (e2ee).</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.redacted <span class="property-type">bool</span></dt>
-                <dd> returns true if the message was redacted (such as deleted by the user).</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.payload <span class="property-type">string</span></dt>
-                <dd>the body from the message's content.</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.userId <span class="property-type">string</span></dt>
-                <dd>the User ID of the message sender. Example: @john:matrix.org</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.topic <span class="property-type">string</span></dt>
-                <dd>the ID of the room. Example: !OGEhHVWSdvArJzumhm:matrix.org</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.event <span class="property-type">object</span></dt>
-                <dd>the event object returned by the Matrix server</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.eventId <span class="property-type">object</span></dt>
-                <dd>The event ID, e.g. $143350589368169JsLZx:localhost</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.content <span class="property-type">object</span></dt>
-                <dd>the message's content object</dd>
-            </dl>
+    <ul>
+        <li>
+            <strong>Output 1 (Paginated Data)</strong>: Returns an array of events if more messages are available. Each event contains details such as:
+            <ul>
+                <li><code>msg.encrypted</code> (boolean) - Indicates if the message was encrypted (end-to-end encryption).</li>
+                <li><code>msg.redacted</code> (boolean) - Indicates if the message was redacted (deleted or hidden).</li>
+                <li><code>msg.payload</code> (string) - The message body or content.</li>
+                <li><code>msg.userId</code> (string) - The user ID of the message sender.</li>
+                <li><code>msg.topic</code> (string) - The room ID of the message's origin.</li>
+                <li><code>msg.eventId</code> (string) - The event ID.</li>
+                <li><code>msg.type</code> (string) - The type of message (e.g., <code>m.text</code>, <code>m.image</code>, <code>m.reaction</code>, etc.).</li>
+            </ul>
         </li>
-
-        <li><code>msg.type</code> == '<strong>m.text</strong>'
-            <div class="form-tips" style="margin-bottom: 12px;">
-                Doesn't return anything extra
-            </div>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.reaction</strong>'
-            <dl class="message-properties">
-                <dt>msg.referenceEventId <span class="property-type">string</span></dt>
-                <dd>the message that the reaction relates to</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.payload <span class="property-type">string</span></dt>
-                <dd>the key of the reaction's content</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.emote</strong>'
-            <div class="form-tips" style="margin-bottom: 12px;">
-                Doesn't return anything extra
-            </div>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.sticker</strong>'
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>URL to the sticker image</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>Matrix URL to the sticker image</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_url <span class="property-type">string</span></dt>
-                <dd>URL to the thumbnail of the sticker</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_mxc_url <span class="property-type">string</span></dt>
-                <dd>Matrix URL to the thumbnail of the sticker</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.file</strong>'
-            <dl class="message-properties">
-                <dt>msg.filename <span class="property-type">string</span></dt>
-                <dd>the file's parsed filename</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>the file's URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>the file's Matrix URL</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.audio</strong>'
-            <dl class="message-properties">
-                <dt>msg.filename <span class="property-type">string</span></dt>
-                <dd>the image's parsed filename</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mimetype <span class="property-type">string</span></dt>
-                <dd>audio file mimetype (ex: audio/ogg)</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>the file's URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>the file's Matrix URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.duration <span class="property-type">integer</span></dt>
-                <dd>duration of audio file in milliseconds</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.waveform <span class="property-type">array[int]</span></dt>
-                <dd>waveform of the audio clip</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.image</strong>'
-            <dl class="message-properties">
-                <dt>msg.filename <span class="property-type">string</span></dt>
-                <dd>the image's parsed filename</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.url <span class="property-type">string</span></dt>
-                <dd>the image's URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.mxc_url <span class="property-type">string</span></dt>
-                <dd>the image's Matrix URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_url <span class="property-type">string</span></dt>
-                <dd>the image's thumbnail URL</dd>
-            </dl>
-
-            <dl class="message-properties">
-                <dt>msg.thumbnail_mxc_url <span class="property-type">string</span></dt>
-                <dd>the image's thumbnail Matrix URL</dd>
-            </dl>
-        </li>
-
-        <li><code>msg.type</code> == '<strong>m.location</strong>'
-            <dl class="message-properties">
-                <dt>msg.geo_uri <span class="property-type">string</span></dt>
-                <dd>URI format of the geolocation</dd>
-            </dl>
+        <li>
+            <strong>Output 2 (Error)</strong>: If an error occurs during pagination, the error message is sent to this output.
         </li>
     </ul>
-</script>
+
+    <h3>Dynamic Properties</h3>
+    <p>Some inputs like <strong>Room</strong>, <strong>Pagination Key</strong>, and <strong>Page Size</strong> can be dynamically set using message, flow, or global context variables.</p>
+
+    <h3>Usage</h3>
+    <p>To paginate through a room's timeline, trigger this node with a <code>msg</code> input. The first run will start the timeline, and a unique pagination key will be generated. Future calls can use this key to continue from where you left off. Use the "Paginate Backwards" option to move through older events or set it to false to move forwards through newer events.</p>
+</script>

src/matrix-paginate-room.js

@@ -1,7 +1,8 @@
-const {TimelineWindow, RelationType, Filter} = require("matrix-js-sdk");
+const sdkPromise = import("matrix-js-sdk");
 const crypto = require('crypto');
+
 module.exports = function(RED) {
-    function MatrixReceiveMessage(n) {
+    function MatrixPaginateRoom(n) {
         RED.nodes.createNode(this, n);
 
         let node = this;
@@ -34,7 +35,7 @@ module.exports = function(RED) {
         });
 
         node.on("input", async function (msg) {
-            if (! node.server || ! node.server.matrixClient) {
+            if (!node.server || !node.server.matrixClient) {
                 node.error("No matrix server selected", msg);
                 return;
             }
@@ -43,43 +44,47 @@ module.exports = function(RED) {
                 let value = property;
                 if (type === "msg") {
                     value = RED.util.getMessageProperty(msg, property);
-                } else if ((type === 'flow') || (type === 'global')) {
+                } else if (type === 'flow' || type === 'global') {
                     try {
                         value = RED.util.evaluateNodeProperty(property, type, node, msg);
                     } catch(e2) {
                         throw new Error("Invalid value evaluation");
                     }
-                } else if(type === "bool") {
+                } else if (type === "bool") {
                     value = (property === 'true');
-                } else if(type === "num") {
+                } else if (type === "num") {
                     value = Number(property);
                 }
                 return value;
             }
 
             function setToValue(value, type, property) {
-                if(type === 'global' || type === 'flow') {
+                if (type === 'global' || type === 'flow') {
                     var contextKey = RED.util.parseContextStore(property);
                     if (/\[msg/.test(contextKey.key)) {
-                        // The key has a nest msg. reference to evaluate first
-                        contextKey.key = RED.util.normalisePropertyExpression(contextKey.key, msg, true)
+                        // The key has a nested msg. reference that must be evaluated first
+                        contextKey.key = RED.util.normalisePropertyExpression(contextKey.key, msg, true);
                     }
                     var target = node.context()[type];
-                    var callback = err => {
+                    target.set(contextKey.key, value, contextKey.store, err => {
                         if (err) {
                             node.error(err, msg);
-                            getterErrors[rule.p] = err.message;
                         }
-                    }
-                    target.set(contextKey.key, value, contextKey.store, callback);
-                } else if(type === 'msg') {
+                    });
+                } else if (type === 'msg') {
                     if (!RED.util.setMessageProperty(msg, property, value)) {
-                        node.warn(RED._("change.errors.no-override",{property:property}));
+                        node.warn(RED._("change.errors.no-override", { property: property }));
                     }
                 }
             }
 
             try {
+                // Dynamically load the SDK
+                const sdk = await sdkPromise;
+                const TimelineWindow = sdk.TimelineWindow;
+                const RelationType = sdk.RelationType;
+                // (Filter was imported originally but is not used, so we omit it.)
+
                 let roomId = getToValue(msg, node.roomType, node.roomValue),
                     paginateBackwards = getToValue(msg, node.paginateBackwardsType, node.paginateBackwardsValue),
                     pageSize = getToValue(msg, node.pageSizeType, node.pageSizeValue),
@@ -87,41 +92,37 @@ module.exports = function(RED) {
 
                 let room = node.server.matrixClient.getRoom(roomId);
 
-                if(!room) {
+                if (!room) {
                     throw new Error(`Room ${roomId} does not exist`);
                 }
-                if(pageSize > node.server.initialSyncLimit) {
+                if (pageSize > node.server.initialSyncLimit) {
                     throw new Error(`Page size=${pageSize} cannot exceed initialSyncLimit=${node.server.initialSyncLimit}`);
                 }
-                if(!pageKey) {
+                if (!pageKey) {
                     pageKey = crypto.randomUUID();
                     setToValue(pageKey, node.paginateKeyType, node.paginateKeyValue);
                 }
                 let timelineWindow = node.timelineWindows.get(pageKey),
                     moreMessages = true;
-                if(!timelineWindow) {
+                if (!timelineWindow) {
                     let timelineSet = room.getUnfilteredTimelineSet();
-                    node.debug(JSON.stringify(timelineSet.getFilter()));
-                    // MatrixClient's option initialSyncLimit gets set to the filter we are using
-                    // so override that value with our pageSize
+                    // MatrixClient's option initialSyncLimit gets set to the filter we are using,
+                    // so override that value with our pageSize.
                     timelineWindow = new TimelineWindow(node.server.matrixClient, timelineSet);
                     await timelineWindow.load(msg.eventId || null, pageSize);
                     node.timelineWindows.set(pageKey, timelineWindow);
                 } else {
-                    moreMessages = await timelineWindow.paginate(paginateBackwards ? 'b' : 'f', pageSize); // b for backwards f for forwards
-                    if(moreMessages) {
+                    moreMessages = await timelineWindow.paginate(paginateBackwards ? 'b' : 'f', pageSize); // 'b' for backwards, 'f' for forwards
+                    if (moreMessages) {
                         await timelineWindow.unpaginate(pageSize, !paginateBackwards);
                     }
                 }
 
-                // MatrixEvent objects are massive so this throws an encode error for the string being too long
-                // since msg objects convert to JSON
-                // msg.payload = moreMessages ? timelineWindow.getEvents() : false;
-
+                // To avoid errors converting massive MatrixEvent objects to JSON, we omit them.
                 msg.payload = false;
                 msg.start = timelineWindow.getTimelineIndex('b')?.index;
                 msg.end = timelineWindow.getTimelineIndex('f')?.index;
-                if(moreMessages) {
+                if (moreMessages) {
                     msg.payload = timelineWindow.getEvents().map(function(event) {
                         return {
                             encrypted    : event.isEncrypted(),
@@ -135,7 +136,7 @@ module.exports = function(RED) {
                             // user         : node.matrixClient.getUser(event.getSender()),
                             topic        : event.getRoomId(),
                             eventId      : event.getId(),
-                            event        : event,
+                            event        : event.getEffectiveEvent(),
                         };
                     });
                 }
@@ -151,5 +152,5 @@ module.exports = function(RED) {
             node.server.deregister(node);
         });
     }
-    RED.nodes.registerType("matrix-paginate-room", MatrixReceiveMessage);
-}
+    RED.nodes.registerType("matrix-paginate-room", MatrixPaginateRoom);
+}

src/matrix-receive.html

@@ -13,6 +13,7 @@
             acceptOwnEvents: {"value": false},
             acceptText: {"value": true},
             acceptEmotes: {"value": true},
+            acceptNotices: {"value": true},
             acceptStickers: {"value": true},
             acceptReactions: {"value": true},
             acceptFiles: {"value": true},
@@ -66,6 +67,16 @@
             Accept text <code style="text-transform: none;">m.text</code>
         </label>
     </div>
+    <div class="form-row" style="margin-bottom:0;">
+        <input
+                type="checkbox"
+                id="node-input-acceptNotices"
+                style="width: auto; margin-left: 125px; vertical-align: top"
+        />
+        <label for="node-input-acceptNotices" style="width: auto">
+            Accept notices <code style="text-transform: none;">m.notice</code>
+        </label>
+    </div>
     <div class="form-row" style="margin-bottom:0;">
         <input
                 type="checkbox"
@@ -216,6 +227,11 @@
                 <dt>msg.content <span class="property-type">object</span></dt>
                 <dd>the message's content object</dd>
             </dl>
+
+            <dl class="message-properties">
+                <dt>msg.headers <span class="property-type">object | null</span></dt>
+                <dd>for media events, includes auth headers (for example <code>Authorization: Bearer ...</code>) used by authed media endpoints.</dd>
+            </dl>
         </li>
 
         <li><code>msg.type</code> == '<strong>m.text</strong>'
@@ -347,4 +363,4 @@
             </dl>
         </li>
     </ul>
-</script>
+</script>

src/matrix-receive.js

@@ -1,4 +1,3 @@
-const {RelationType} = require("matrix-js-sdk");
 module.exports = function(RED) {
     function MatrixReceiveMessage(n) {
         RED.nodes.createNode(this, n);
@@ -10,6 +9,7 @@ module.exports = function(RED) {
         this.acceptOwnEvents = n.acceptOwnEvents;
         this.acceptText = n.acceptText;
         this.acceptEmotes = n.acceptEmotes;
+        this.acceptNotices = n.acceptNotices;
         this.acceptStickers = n.acceptStickers;
         this.acceptReactions = n.acceptReactions;
         this.acceptFiles = n.acceptFiles;
@@ -18,7 +18,7 @@ module.exports = function(RED) {
         this.acceptVideos = n.acceptVideos;
         this.acceptLocations = n.acceptLocations;
         this.roomId = n.roomId;
-        this.roomIds = this.roomId ? this.roomId.split(',') : [];
+        this.roomIds = this.roomId ? this.roomId.split(',').map(s => s.trim()) : [];
 
         node.status({ fill: "red", shape: "ring", text: "disconnected" });
 
@@ -38,120 +38,128 @@ module.exports = function(RED) {
 
         node.server.on("Room.timeline", async function(event, room, toStartOfTimeline, removed, data, msg) {
             // if node has a room ID set we only listen on that room
-            if(node.roomIds.length && node.roomIds.indexOf(room.roomId) === -1) {
+            if (node.roomIds.length && !node.roomIds.includes(room.roomId)) {
                 return;
             }
 
-            if (!node.acceptOwnEvents && ( !event.getSender() || event.getSender() === node.userId ) ) {
-                node.log("Ignoring" + (msg.encrypted ? ' encrypted' : '') +" timeline event [" + msg.type + "]: (" + room.name + ") " + event.getId() + " for reason: own event");
+            if (!node.acceptOwnEvents && (!event.getSender() || event.getSender().toLowerCase() === node.server.matrixClient.getUserId().toLowerCase())) {
+                node.log(`Ignoring${msg.encrypted ? ' encrypted' : ''} timeline event [${msg.type}]: (${room.name}) ${event.getId()} for reason: own event`);
                 return;
             }
 
-            switch(msg.type) {
+            const setAuthHeaders = () => {
+                const accessToken = node.server.matrixClient.getAccessToken?.();
+                if (accessToken) {
+                    msg.headers = {
+                        ...(msg.headers || {}),
+                        Authorization: `Bearer ${accessToken}`,
+                    };
+                }
+            };
+
+            const setUrls = (urlKey, encryptedKey) => {
+                const url = msg.encrypted ? msg.content[encryptedKey]?.url : msg.content[urlKey];
+                if (url) {
+                    const authenticatedUrl = node.server.matrixClient.mxcUrlToHttp(
+                        url,
+                        undefined,
+                        undefined,
+                        undefined,
+                        false,
+                        true,
+                        true,
+                    );
+                    msg.url = authenticatedUrl || node.server.matrixClient.mxcUrlToHttp(url);
+                    msg.mxc_url = url;
+                    setAuthHeaders();
+                }
+            };
+
+            const setThumbnailUrls = (infoKey) => {
+                const thumbnailFile = msg.content.info?.[infoKey];
+                const thumbnailUrl = thumbnailFile?.url;
+                if (thumbnailUrl) {
+                    const authenticatedThumbnailUrl = node.server.matrixClient.mxcUrlToHttp(
+                        thumbnailUrl,
+                        undefined,
+                        undefined,
+                        undefined,
+                        false,
+                        true,
+                        true,
+                    );
+                    msg.thumbnail_url = authenticatedThumbnailUrl || node.server.matrixClient.mxcUrlToHttp(thumbnailUrl);
+                    msg.thumbnail_mxc_url = thumbnailUrl;
+                    setAuthHeaders();
+                }
+            };
+
+            switch (msg.type) {
                 case 'm.emote':
-                    if(!node.acceptEmotes) return;
+                    if (!node.acceptEmotes) return;
+                    break;
+
+                case 'm.notice':
+                    if (!node.acceptNotices) return;
                     break;
 
                 case 'm.text':
-                    if(!node.acceptText) return;
+                    if (!node.acceptText) return;
                     break;
 
                 case 'm.sticker':
-                    if(!node.acceptStickers) return;
-                    if(msg.content.info) {
-                        if(msg.content.info.thumbnail_url) {
-                            msg.thumbnail_url = node.server.matrixClient.mxcUrlToHttp(msg.content.info.thumbnail_url);
-                            msg.thumbnail_mxc_url = msg.content.info.thumbnail_url;
-                        }
-
-                        if(msg.content.url) {
-                            msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.url);
-                            msg.mxc_url = msg.content.url;
-                        }
-                    }
+                    if (!node.acceptStickers) return;
+                    setThumbnailUrls('thumbnail_url');
+                    setUrls('url', 'url');
                     break;
 
                 case 'm.file':
-                    if(!node.acceptFiles) return;
+                    if (!node.acceptFiles) return;
                     msg.filename = msg.content.filename || msg.content.body;
-                    if(msg.encrypted) {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.file.url);
-                        msg.mxc_url = msg.content.file.url;
-                    } else {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.url);
-                        msg.mxc_url = msg.content.url;
-                    }
+                    setUrls('url', 'file');
                     break;
 
                 case 'm.audio':
-                    if(!node.acceptAudio) return;
-                    if(msg.encrypted) {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.file.url);
-                        msg.mxc_url = msg.content.file.url;
-                    } else {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.url);
-                        msg.mxc_url = msg.content.url;
-                    }
-
-                    if('org.matrix.msc1767.file' in msg.content) {
+                    if (!node.acceptAudio) return;
+                    setUrls('url', 'file');
+                    if ('org.matrix.msc1767.file' in msg.content) {
                         msg.filename = msg.content['org.matrix.msc1767.file'].name;
                         msg.mimetype = msg.content['org.matrix.msc1767.file'].mimetype;
                     }
-
-                    if('org.matrix.msc1767.audio' in msg.content) {
+                    if ('org.matrix.msc1767.audio' in msg.content) {
                         msg.duration = msg.content['org.matrix.msc1767.audio'].duration;
                         msg.waveform = msg.content['org.matrix.msc1767.audio'].waveform;
                     }
                     break;
 
                 case 'm.image':
-                    if(!node.acceptImages) return;
+                    if (!node.acceptImages) return;
                     msg.filename = msg.content.filename || msg.content.body;
-                    if(msg.encrypted) {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.file.url);
-                        msg.mxc_url = msg.content.file.url;
-                        msg.thumbnail_url = node.server.matrixClient.mxcUrlToHttp(msg.content.info.thumbnail_file.url);
-                        msg.thumbnail_mxc_url = msg.content.info.thumbnail_file.url;
-                    } else {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.url);
-                        msg.mxc_url = msg.content.url;
-                        msg.thumbnail_url = node.server.matrixClient.mxcUrlToHttp(msg.content.info.thumbnail_url);
-                        msg.thumbnail_mxc_url = msg.content.info.thumbnail_url;
-                    }
+                    setUrls('url', 'file');
+                    setThumbnailUrls('thumbnail_file');
                     break;
 
-
                 case 'm.video':
-                    if(!node.acceptVideos) return;
+                    if (!node.acceptVideos) return;
                     msg.filename = msg.content.filename || msg.content.body;
-                    if(msg.encrypted) {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.file.url);
-                        msg.mxc_url = msg.content.file.url;
-                        msg.thumbnail_url = node.server.matrixClient.mxcUrlToHttp(msg.content.info.thumbnail_file.url);
-                        msg.thumbnail_mxc_url = msg.content.info.thumbnail_file.url;
-                    } else {
-                        msg.url = node.server.matrixClient.mxcUrlToHttp(msg.content.url);
-                        msg.mxc_url = msg.content.url;
-                        msg.thumbnail_url = node.server.matrixClient.mxcUrlToHttp(msg.content.info.thumbnail_url);
-                        msg.thumbnail_mxc_url = msg.content.info.thumbnail_url;
-                    }
+                    setUrls('url', 'file');
+                    setThumbnailUrls('thumbnail_file');
                     break;
 
                 case 'm.location':
-                    if(!node.acceptLocations) return;
+                    if (!node.acceptLocations) return;
                     msg.geo_uri = msg.content.geo_uri;
                     msg.payload = msg.content.body;
                     break;
 
                 case 'm.reaction':
-                    if(!node.acceptReactions) return;
+                    if (!node.acceptReactions) return;
                     msg.info = msg.content["m.relates_to"].info;
                     msg.referenceEventId = msg.content["m.relates_to"].event_id;
                     msg.payload = msg.content["m.relates_to"].key;
                     break;
 
                 default:
-                    // node.warn("Unknown event type: " + msg.type);
                     return;
             }
 
@@ -163,4 +171,4 @@ module.exports = function(RED) {
         });
     }
     RED.nodes.registerType("matrix-receive", MatrixReceiveMessage);
-}
+}

src/matrix-send-file.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
     RED.nodes.registerType('matrix-send-file',{
-        category: 'matrix',
+        category: 'matrix (deprecated)',
         color: '#00b7ca',
         icon: "matrix.png",
         outputLabels: ["success", "error"],
@@ -20,6 +20,26 @@
 </script>
 
 <script type="text/html" data-template-name="matrix-send-file">
+    <style>
+        .matrix-chat-alert {
+            color: #b94a48;
+            background-color: #f2dede;
+            border-color: #eed3d7;
+            margin: 30px 0;
+            padding: 8px 35px 8px 14px;
+        }
+
+        .matrix-chat-alert a, .matrix-chat-alert a:active, .matrix-chat-alert a:hover {
+            color: #b94a48;
+            text-decoration: underline;
+            font-weight: bold;
+        }
+    </style>
+    <div class="matrix-chat-alert">
+        <strong>Deprecation Warning!</strong> This node will be removed in a future release. We have consolidated the Send File & Send Image nodes into a single Upload File node (with more options). Read <a href="https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/issues/102" target="_blank">here</a> for more info.<br>
+        <br>
+        Replace this node with a File Upload node attached to a Send Message node to accomplish the same behavior.
+    </div>
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">

src/matrix-send-image.html

@@ -1,6 +1,6 @@
 <script type="text/javascript">
     RED.nodes.registerType('matrix-send-image',{
-        category: 'matrix',
+        category: 'matrix (deprecated)',
         color: '#00b7ca',
         icon: "matrix.png",
         outputLabels: ["success", "error"],
@@ -20,6 +20,26 @@
 </script>
 
 <script type="text/html" data-template-name="matrix-send-image">
+    <style>
+        .matrix-chat-alert {
+            color: #b94a48;
+            background-color: #f2dede;
+            border-color: #eed3d7;
+            margin: 30px 0;
+            padding: 8px 35px 8px 14px;
+        }
+
+        .matrix-chat-alert a, .matrix-chat-alert a:active, .matrix-chat-alert a:hover {
+            color: #b94a48;
+            text-decoration: underline;
+            font-weight: bold;
+        }
+    </style>
+    <div class="matrix-chat-alert">
+        <strong>Deprecation Warning!</strong> This node will be removed in a future release. We have consolidated the Send File & Send Image nodes into a single Upload File node (with more options). Read <a href="https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/issues/102" target="_blank">here</a> for more info.<br>
+        <br>
+        Replace this node with a File Upload node attached to a Send Message node to accomplish the same behavior.
+    </div>
     <div class="form-row">
         <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
         <input type="text" id="node-input-name" placeholder="Name">

src/matrix-send-message.html

@@ -89,6 +89,9 @@
         <label for="node-input-threadReply"><i class="fa fa-commenting-o"></i> Thread Reply</label>
         <input type="text" id="node-input-threadReply">
     </div>
+    <div class="form-row form-tips">
+        If true and <code>msg.content.['m.relates_to'].event_id</code> or <code>msg.eventId</code> (parsed in that order) is provided the message will be a thread reply to the original event.
+    </div>
 
     <div class="form-row">
         <label for="node-input-messageFormat">

src/matrix-send-message.js

@@ -1,9 +1,8 @@
-const {RelationType} = require("matrix-js-sdk");
+const sdkPromise = import("matrix-js-sdk");
 
 module.exports = function(RED) {
     function MatrixSendImage(n) {
         RED.nodes.createNode(this, n);
-
         var node = this;
 
         this.name = n.name;
@@ -68,12 +67,17 @@ module.exports = function(RED) {
             node.status({ fill: "green", shape: "ring", text: "connected" });
         });
 
-        node.on("input", function (msg) {
+        // Make the input handler async so we can await the dynamic import.
+        node.on("input", async function (msg) {
+            // Await the SDK import and get the RelationType constant.
+            const sdk = await sdkPromise;
+            const RelationType = sdk.RelationType;
+
             function getToValue(msg, type, property) {
                 let value = property;
                 if (type === "msg") {
                     value = RED.util.getMessageProperty(msg, property);
-                } else if ((type === 'flow') || (type === 'global')) {
+                } else if (type === 'flow' || type === 'global') {
                     try {
                         value = RED.util.evaluateNodeProperty(property, type, node, msg);
                     } catch(e2) {
@@ -115,19 +119,19 @@ module.exports = function(RED) {
             }
 
             let content = null;
-            if(typeof payload === 'object') {
+            if (typeof payload === 'object') {
                 content = payload;
             } else {
-                if(msgType === 'msg.type') {
-                    if(!msg.type) {
-                        node.error("msg.type type is set to be passed in via msg.type but was not defined", msg);
+                if (msgType === 'msg.type') {
+                    if (!msg.type) {
+                        node.error("msg.type is set to be passed in via msg.type but was not defined", msg);
                         return;
                     }
                     msgType = msg.type;
                 }
 
-                if(msgFormat === 'msg.format') {
-                    if(!msg.format) {
+                if (msgFormat === 'msg.format') {
+                    if (!Object.hasOwn(msg, 'format')) {
                         node.error("Message format is set to be passed in via msg.format but was not defined", msg);
                         return;
                     }
@@ -139,7 +143,7 @@ module.exports = function(RED) {
                     body: payload.toString()
                 };
 
-                if(msgFormat === 'html') {
+                if (msgFormat === 'html') {
                     content.format = "org.matrix.custom.html";
                     content.formatted_body =
                         (typeof msg.formatted_payload !== 'undefined' && msg.formatted_payload)
@@ -147,15 +151,15 @@ module.exports = function(RED) {
                             : payload.toString();
                 }
 
-                if((node.replaceMessage || msg.replace) && msg.eventId) {
+                if ((node.replaceMessage || msg.replace) && msg.eventId) {
                     content['m.new_content'] = {
                         msgtype: content.msgtype,
                         body: content.body
                     };
-                    if('format' in content) {
+                    if ('format' in content) {
                         content['m.new_content']['format'] = content['format'];
                     }
-                    if('formatted_body' in content) {
+                    if ('formatted_body' in content) {
                         content['m.new_content']['formatted_body'] = content['formatted_body'];
                     }
 
@@ -164,17 +168,19 @@ module.exports = function(RED) {
                         event_id: msg.eventId
                     };
                     content['body'] = ' * ' + content['body'];
-                } else if(threadReply) {
-                    // if incoming message is a reply to a thread we fetch the thread parent from the m.relates_to property
-                    // otherwise fallback to msg.eventId
-                    let threadParent = (msg?.content?.['m.relates_to']?.rel_type === RelationType.Thread ? msg?.content?.['m.relates_to']?.event_id : null) || msg.eventId;
-                    if(threadParent) {
+                } else if (threadReply) {
+                    // If incoming message is a reply to a thread we fetch the thread parent from m.relates_to,
+                    // otherwise fallback to msg.eventId.
+                    let threadParent = (msg?.content?.['m.relates_to']?.rel_type === RelationType.Thread
+                        ? msg?.content?.['m.relates_to']?.event_id
+                        : null) || msg.eventId;
+                    if (threadParent) {
                         content["m.relates_to"] = {
                             "rel_type": RelationType.Thread,
                             "event_id": threadParent,
                             "is_falling_back": true,
                         };
-                        if(msg.eventId !== threadParent) {
+                        if (msg.eventId !== threadParent) {
                             content["m.relates_to"]["m.in_reply_to"] = {
                                 "event_id": msg.eventId
                             };
@@ -191,7 +197,7 @@ module.exports = function(RED) {
                     node.send([msg, null]);
                 })
                 .catch(function(e){
-                    node.warn("Error sending message " + e);
+                    node.error("Error sending message: " + e, {});
                     msg.error = e;
                     node.send([null, msg]);
                 });
@@ -202,4 +208,4 @@ module.exports = function(RED) {
         });
     }
     RED.nodes.registerType("matrix-send-message", MatrixSendImage);
-}
+};

src/matrix-server-config.html

@@ -31,16 +31,765 @@
             accessToken: { type: "password", required: true },
             deviceId: { type: "text", required: false },
             url: { type: "text", required: true },
+            password: { type: "password", required: false },
         },
         defaults: {
             name: { value: null },
             autoAcceptRoomInvites: { value: true },
             enableE2ee: { type: "checkbox", value: true },
-            global: { type: "checkbox", value: true }
+            global: { type: "checkbox", value: true },
+            allowUnknownDevices: { type: "checkbox", value: true }
         },
         icon: "matrix.png",
         label: function() {
             return this.name || undefined;
+        },
+        oneditprepare: function() {
+            const nodeId = this.id;
+
+            // --- Secure backup / cross-signing setup (modal dialog) ---
+            // The modal is built once and reused across editor sessions; the
+            // current node id is stored on the overlay so its handlers target
+            // whichever server config node is being edited.
+            if (!document.getElementById("matrix-sb-overlay")) {
+                $('<style>'
+                    + '.matrix-sb-overlay{position:fixed;inset:0;z-index:3000;display:none;background:rgba(0,0,0,.45);}'
+                    + '.matrix-sb-modal{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);'
+                    + 'width:540px;max-width:92vw;max-height:88vh;display:flex;flex-direction:column;'
+                    + 'border-radius:6px;overflow:hidden;box-shadow:0 12px 44px rgba(0,0,0,.45);'
+                    + 'background:var(--red-ui-primary-background,#fff);color:var(--red-ui-primary-text-color,#2a2a2a);}'
+                    + '.matrix-sb-head{display:flex;justify-content:space-between;align-items:center;'
+                    + 'padding:12px 16px;font-size:15px;font-weight:bold;'
+                    + 'background:var(--red-ui-secondary-background,#f3f3f3);'
+                    + 'border-bottom:1px solid var(--red-ui-secondary-border-color,#ddd);}'
+                    + '.matrix-sb-x{cursor:pointer;font-size:20px;line-height:1;opacity:.55;}'
+                    + '.matrix-sb-x:hover{opacity:1;}'
+                    + '.matrix-sb-body{padding:16px;overflow:auto;}'
+                    + '.matrix-sb-state{display:flex;gap:10px;align-items:flex-start;font-size:14px;line-height:1.5;}'
+                    + '.matrix-sb-section{margin-top:18px;}'
+                    + '.matrix-sb-section label{display:block;font-weight:bold;margin-bottom:5px;}'
+                    + '.matrix-sb-section input{width:100%;box-sizing:border-box;padding:7px 9px;border-radius:4px;'
+                    + 'border:1px solid var(--red-ui-form-input-border-color,#ccc);'
+                    + 'background:var(--red-ui-form-input-background,#fff);color:var(--red-ui-primary-text-color,#2a2a2a);}'
+                    + '.matrix-sb-hint{color:var(--red-ui-secondary-text-color,#888);font-size:12px;margin-top:5px;}'
+                    + '.matrix-sb-actions{margin-top:12px;text-align:right;}'
+                    + '.matrix-sb-warn{background:#fdf3e7;border:1px solid #f0c36d;color:#7a5b16;'
+                    + 'border-radius:4px;padding:9px 11px;font-size:13px;margin-bottom:12px;}'
+                    + '.matrix-sb-result{margin-top:18px;padding:11px 13px;border-radius:4px;font-size:13px;white-space:pre-wrap;}'
+                    + '.matrix-sb-result.ok{background:#e7f4ea;border:1px solid #8fcea5;color:#1e6b33;}'
+                    + '.matrix-sb-result.err{background:#fde7e9;border:1px solid #e8a0a8;color:#8a1f2b;}'
+                    + '.matrix-sb-key{margin-top:9px;padding:9px;border-radius:4px;font-family:monospace;'
+                    + 'font-size:13px;word-break:break-all;background:rgba(127,127,127,.16);border:1px dashed #999;}'
+                    + '.matrix-sb-foot{display:flex;justify-content:flex-end;gap:8px;padding:10px 16px;'
+                    + 'background:var(--red-ui-secondary-background,#f3f3f3);'
+                    + 'border-top:1px solid var(--red-ui-secondary-border-color,#ddd);}'
+                    + '</style>').appendTo("head");
+
+                $('<div id="matrix-sb-overlay" class="matrix-sb-overlay"><div class="matrix-sb-modal">'
+                    + '<div class="matrix-sb-head"><span><i class="fa fa-shield"></i> Secure Backup &amp; Cross-signing</span>'
+                    + '<span class="matrix-sb-x" id="matrix-sb-x" title="Close">&times;</span></div>'
+                    + '<div class="matrix-sb-body">'
+                    + '<div class="matrix-sb-state" id="matrix-sb-state"></div>'
+                    + '<div class="matrix-sb-section" id="matrix-sb-unlock" style="display:none;">'
+                    + '<label>Recovery key or passphrase</label>'
+                    + '<input type="text" id="matrix-sb-recoverykey" placeholder="EsTx xxxx xxxx xxxx ...">'
+                    + '<div class="matrix-sb-hint">The recovery key created when secure backup / key storage was first set up on this account.</div>'
+                    + '<div class="matrix-sb-actions"><button type="button" class="red-ui-button" id="matrix-sb-unlock-btn">Unlock &amp; set up cross-signing</button></div>'
+                    + '</div>'
+                    + '<div class="matrix-sb-section" id="matrix-sb-reset" style="display:none;">'
+                    + '<div class="matrix-sb-warn">Resetting creates new cross-signing keys and a new recovery key, replacing the existing ones. Other sessions that trusted the old identity will need to be re-verified.</div>'
+                    + '<label>Account password</label>'
+                    + '<input type="password" id="matrix-sb-password" placeholder="Account password">'
+                    + '<div class="matrix-sb-actions"><button type="button" class="red-ui-button" id="matrix-sb-reset-btn">Reset cross-signing &amp; secure backup</button></div>'
+                    + '</div>'
+                    + '<div class="matrix-sb-result" id="matrix-sb-result" style="display:none;"></div>'
+                    + '</div>'
+                    + '<div class="matrix-sb-foot">'
+                    + '<button type="button" class="red-ui-button" id="matrix-sb-reset-toggle" style="display:none;">Reset instead…</button>'
+                    + '<button type="button" class="red-ui-button" id="matrix-sb-close">Close</button>'
+                    + '</div></div></div>').appendTo(document.body);
+
+                var sbEsc = function(s) { return $("<div>").text(s == null ? "" : String(s)).html(); };
+                var sbClose = function() { $("#matrix-sb-overlay").fadeOut(120); };
+                var sbId = function() { return $("#matrix-sb-overlay").data("matrixNodeId"); };
+                var sbBtns = function(disabled) { $("#matrix-sb-unlock-btn,#matrix-sb-reset-btn").prop("disabled", disabled); };
+                var sbCall = function(body) {
+                    return $.ajax({
+                        url: "matrix-chat/secure-backup", type: "POST",
+                        contentType: "application/json", data: JSON.stringify(body),
+                    });
+                };
+                var sbState = function(icon, color, html) {
+                    $("#matrix-sb-state").html('<i class="fa ' + icon + '" style="color:' + color + ';font-size:18px;"></i><span>' + html + '</span>');
+                };
+                var sbResult = function(ok, text, key) {
+                    var h = sbEsc(text);
+                    if (key) { h += '<div class="matrix-sb-key">' + sbEsc(key) + '</div>'; }
+                    $("#matrix-sb-result").removeClass("ok err").addClass(ok ? "ok" : "err").html(h).show();
+                };
+                var sbStatus = function() {
+                    $("#matrix-sb-unlock,#matrix-sb-reset,#matrix-sb-result,#matrix-sb-reset-toggle").hide();
+                    sbState("fa-spinner fa-spin", "#888", "Checking the account…");
+                    sbCall({ id: sbId(), action: "status" }).done(function(data) {
+                        if (data.result !== "ok") {
+                            sbState("fa-exclamation-triangle", "#c9302c", "Could not check the account.");
+                            sbResult(false, data.message || "Unknown error");
+                            return;
+                        }
+                        if (data.crossSigningReady) {
+                            sbState("fa-check-circle", "#3a9a4e", "<b>Cross-signing is set up.</b> The bot's device is cross-signed.");
+                            $("#matrix-sb-reset-toggle").show();
+                        } else if (data.secretStorageExists) {
+                            sbState("fa-lock", "#d18a1b", "This account has an existing secure backup. Enter its recovery key to set up cross-signing for the bot.");
+                            $("#matrix-sb-recoverykey").val("");
+                            $("#matrix-sb-unlock,#matrix-sb-reset-toggle").show();
+                        } else {
+                            sbState("fa-shield", "#888", "No secure backup exists yet. Set one up to enable cross-signing.");
+                            $("#matrix-sb-password").val("");
+                            $("#matrix-sb-reset").show();
+                        }
+                        sbBtns(false);
+                    }).fail(function() {
+                        sbState("fa-exclamation-triangle", "#c9302c", "Request failed — is Node-RED still running?");
+                    });
+                };
+
+                $("#matrix-sb-x,#matrix-sb-close").on("click", sbClose);
+                $("#matrix-sb-overlay").on("mousedown", function(e) { if (e.target === this) { sbClose(); } });
+                $(document).on("keydown.matrixsb", function(e) {
+                    if (e.key === "Escape" && $("#matrix-sb-overlay").is(":visible")) { sbClose(); }
+                });
+                $("#matrix-sb-reset-toggle").on("click", function() {
+                    $(this).hide();
+                    $("#matrix-sb-password").val("");
+                    $("#matrix-sb-reset").show();
+                });
+                $("#matrix-sb-unlock-btn").on("click", function() {
+                    sbBtns(true);
+                    sbState("fa-spinner fa-spin", "#888", "Unlocking secure backup…");
+                    sbCall({ id: sbId(), action: "unlock", recoveryKey: $("#matrix-sb-recoverykey").val() })
+                        .done(function(data) {
+                            if (data.result !== "ok") {
+                                sbState("fa-lock", "#d18a1b", "Enter the recovery key to set up cross-signing.");
+                                sbResult(false, data.message); sbBtns(false); return;
+                            }
+                            $("#matrix-sb-unlock,#matrix-sb-reset,#matrix-sb-reset-toggle").hide();
+                            sbState("fa-check-circle", "#3a9a4e", "<b>Done.</b>");
+                            sbResult(true, data.message);
+                        })
+                        .fail(function() { sbResult(false, "Request failed — is Node-RED still running?"); sbBtns(false); });
+                });
+                $("#matrix-sb-reset-btn").on("click", function() {
+                    sbBtns(true);
+                    sbState("fa-spinner fa-spin", "#888", "Resetting cross-signing & secure backup…");
+                    sbCall({ id: sbId(), action: "reset", password: $("#matrix-sb-password").val() })
+                        .done(function(data) {
+                            if (data.result !== "ok") {
+                                sbState("fa-shield", "#d18a1b", "Enter the account password to reset.");
+                                sbResult(false, data.message); sbBtns(false); return;
+                            }
+                            $("#matrix-sb-unlock,#matrix-sb-reset,#matrix-sb-reset-toggle").hide();
+                            sbState("fa-check-circle", "#3a9a4e", "<b>Reset complete.</b>");
+                            sbResult(true, data.message, data.recoveryKey);
+                        })
+                        .fail(function() { sbResult(false, "Request failed — is Node-RED still running?"); sbBtns(false); });
+                });
+
+                // expose the status loader so per-session click handlers can call it
+                $("#matrix-sb-overlay").data("sbStatusFn", sbStatus);
+            }
+
+            $("#matrix-secure-backup-btn").on("click", function() {
+                $("#matrix-sb-overlay").data("matrixNodeId", nodeId).fadeIn(120);
+                $("#matrix-sb-overlay").data("sbStatusFn")();
+            });
+
+            // --- Verification list (modal) ---
+            // Built once and reused; the node id is stored on the overlay.
+            if (!document.getElementById("matrix-vl-overlay")) {
+                $('<style>'
+                    + '.matrix-vl-overlay{position:fixed;inset:0;z-index:3000;display:none;background:rgba(0,0,0,.45);}'
+                    + '.matrix-vl-modal{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);'
+                    + 'width:560px;max-width:92vw;max-height:88vh;display:flex;flex-direction:column;'
+                    + 'border-radius:6px;overflow:hidden;box-shadow:0 12px 44px rgba(0,0,0,.45);'
+                    + 'background:var(--red-ui-primary-background,#fff);color:var(--red-ui-primary-text-color,#2a2a2a);}'
+                    + '.matrix-vl-head{display:flex;justify-content:space-between;align-items:center;'
+                    + 'padding:12px 16px;font-size:15px;font-weight:bold;'
+                    + 'background:var(--red-ui-secondary-background,#f3f3f3);'
+                    + 'border-bottom:1px solid var(--red-ui-secondary-border-color,#ddd);}'
+                    + '.matrix-vl-x{cursor:pointer;font-size:20px;line-height:1;opacity:.55;}'
+                    + '.matrix-vl-x:hover{opacity:1;}'
+                    + '.matrix-vl-body{padding:14px 16px;overflow:auto;}'
+                    + '.matrix-vl-note{font-size:12px;color:var(--red-ui-secondary-text-color,#888);margin-bottom:10px;}'
+                    + '.matrix-vl-item{display:flex;justify-content:space-between;gap:12px;padding:10px 12px;'
+                    + 'margin-bottom:8px;border-radius:5px;cursor:pointer;'
+                    + 'border:1px solid var(--red-ui-secondary-border-color,#ddd);'
+                    + 'background:var(--red-ui-secondary-background,#f7f7f7);}'
+                    + '.matrix-vl-item:hover{border-color:var(--red-ui-node-border,#999);}'
+                    + '.matrix-vl-item-l{flex:1;min-width:0;}'
+                    + '.matrix-vl-item-title{font-weight:bold;}'
+                    + '.matrix-vl-item-sub{font-size:12px;color:var(--red-ui-secondary-text-color,#888);'
+                    + 'margin-top:2px;word-break:break-word;}'
+                    + '.matrix-vl-item-r{text-align:right;font-size:12px;white-space:nowrap;}'
+                    + '.matrix-vl-exp{color:#d18a1b;}'
+                    + '.matrix-vl-empty,.matrix-vl-more{font-size:13px;'
+                    + 'color:var(--red-ui-secondary-text-color,#888);padding:6px 2px;}'
+                    + '.matrix-vl-d-state{display:flex;gap:10px;align-items:flex-start;font-size:14px;line-height:1.5;}'
+                    + '.matrix-vl-d-state .fa{font-size:18px;}'
+                    + '.matrix-vl-sas{display:flex;flex-wrap:wrap;gap:10px;margin:14px 0;}'
+                    + '.matrix-vl-emoji{width:88px;text-align:center;padding:8px 4px;border-radius:5px;'
+                    + 'background:var(--red-ui-secondary-background,#f3f3f3);'
+                    + 'border:1px solid var(--red-ui-secondary-border-color,#ddd);}'
+                    + '.matrix-vl-emoji .e{font-size:30px;line-height:1.3;}'
+                    + '.matrix-vl-emoji .n{font-size:11px;color:var(--red-ui-secondary-text-color,#888);text-transform:capitalize;}'
+                    + '.matrix-vl-result{margin-top:12px;padding:10px 12px;border-radius:4px;font-size:13px;}'
+                    + '.matrix-vl-foot{display:flex;align-items:center;gap:8px;padding:10px 16px;'
+                    + 'background:var(--red-ui-secondary-background,#f3f3f3);'
+                    + 'border-top:1px solid var(--red-ui-secondary-border-color,#ddd);}'
+                    + '</style>').appendTo("head");
+
+                $('<div id="matrix-vl-overlay" class="matrix-vl-overlay"><div class="matrix-vl-modal">'
+                    + '<div class="matrix-vl-head"><span><i class="fa fa-check-circle"></i> Device Verification</span>'
+                    + '<span class="matrix-vl-x" id="matrix-vl-x" title="Close">&times;</span></div>'
+                    + '<div class="matrix-vl-body">'
+                    + '<div id="matrix-vl-listview">'
+                    + '<div class="matrix-vl-note">Pending verification requests &mdash; this list refreshes every 5 seconds. Click a request to verify it.</div>'
+                    + '<div id="matrix-vl-items"></div>'
+                    + '<div id="matrix-vl-empty" class="matrix-vl-empty" style="display:none;">No pending verification requests.</div>'
+                    + '<div id="matrix-vl-more" class="matrix-vl-more" style="display:none;"></div>'
+                    + '</div>'
+                    + '<div id="matrix-vl-detailview" style="display:none;">'
+                    + '<div id="matrix-vl-d-head" class="matrix-vl-item-sub" style="margin-bottom:10px;"></div>'
+                    + '<div id="matrix-vl-d-state" class="matrix-vl-d-state"></div>'
+                    + '<div id="matrix-vl-d-sas" class="matrix-vl-sas" style="display:none;"></div>'
+                    + '<div id="matrix-vl-d-actions" style="display:none;text-align:right;">'
+                    + '<button type="button" class="red-ui-button" id="matrix-vl-d-mismatch">They don&#39;t match</button> '
+                    + '<button type="button" class="red-ui-button" id="matrix-vl-d-confirm">They match</button>'
+                    + '</div>'
+                    + '<div id="matrix-vl-d-result" class="matrix-vl-result" style="display:none;"></div>'
+                    + '</div>'
+                    + '</div>'
+                    + '<div class="matrix-vl-foot">'
+                    + '<button type="button" class="red-ui-button" id="matrix-vl-back" style="display:none;">&larr; Back to list</button>'
+                    + '<span style="flex:1;"></span>'
+                    + '<button type="button" class="red-ui-button" id="matrix-vl-cancel" style="display:none;">Cancel verification</button>'
+                    + '<button type="button" class="red-ui-button" id="matrix-vl-close">Close</button>'
+                    + '</div></div></div>').appendTo(document.body);
+
+                var vlListTimer = null, vlTickTimer = null, vlDetailTimer = null;
+                var vlEsc = function(s) { return $("<div>").text(s == null ? "" : String(s)).html(); };
+                var vlId = function() { return $("#matrix-vl-overlay").data("matrixNodeId"); };
+                var vlCurId = function() { return $("#matrix-vl-overlay").data("vlCurrentId"); };
+                var vlCall = function(body) {
+                    return $.ajax({
+                        url: "matrix-chat/verification", type: "POST",
+                        contentType: "application/json", data: JSON.stringify(body),
+                    });
+                };
+                var vlClearTimers = function() {
+                    if(vlListTimer) { clearInterval(vlListTimer); vlListTimer = null; }
+                    if(vlTickTimer) { clearInterval(vlTickTimer); vlTickTimer = null; }
+                    if(vlDetailTimer) { clearInterval(vlDetailTimer); vlDetailTimer = null; }
+                };
+                var vlDur = function(ms) {
+                    var s = Math.max(0, Math.round(ms / 1000));
+                    if(s < 60) { return s + "s"; }
+                    var m = Math.floor(s / 60), r = s % 60;
+                    return m + "m " + (r < 10 ? "0" : "") + r + "s";
+                };
+                var vlState = function(icon, color, html) {
+                    $("#matrix-vl-d-state").html('<i class="fa ' + icon + '" style="color:' + color + ';"></i><span>' + html + '</span>');
+                };
+
+                var vlTick = function() {
+                    var now = Date.now();
+                    $("#matrix-vl-items .matrix-vl-item").each(function() {
+                        var $it = $(this);
+                        var seen = parseInt($it.attr("data-seen"), 10);
+                        var expires = $it.attr("data-expires");
+                        $it.find(".matrix-vl-age").text(isNaN(seen) ? "" : "age " + vlDur(now - seen));
+                        if(expires) {
+                            var left = parseInt(expires, 10) - now;
+                            $it.find(".matrix-vl-exp").text(left > 0 ? "expires in " + vlDur(left) : "expired");
+                        }
+                    });
+                };
+                var vlRenderList = function(data) {
+                    if(data.result !== "ok") {
+                        $("#matrix-vl-items").html('<div class="matrix-vl-empty">' + vlEsc(data.message) + '</div>');
+                        $("#matrix-vl-empty,#matrix-vl-more").hide();
+                        return;
+                    }
+                    var now = Date.now();
+                    var $items = $("#matrix-vl-items").empty();
+                    (data.verifications || []).forEach(function(v) {
+                        var typeLabel = v.type === "room" ? "Room verification" : "Device verification";
+                        var sub = "from " + vlEsc(v.userId || "unknown");
+                        if(v.type === "device" && v.deviceId) { sub += " &middot; device " + vlEsc(v.deviceId); }
+                        else if(v.type === "room" && v.roomId) { sub += " &middot; in room " + vlEsc(v.roomId); }
+                        if(v.isSelfVerification) { sub += " &middot; your own session"; }
+                        $items.append($('<div class="matrix-vl-item">')
+                            .attr("data-vid", v.verificationId)
+                            .attr("data-seen", now - (v.ageMs || 0))
+                            .attr("data-expires", (v.expiresInMs != null) ? (now + v.expiresInMs) : "")
+                            .html('<div class="matrix-vl-item-l"><div class="matrix-vl-item-title">' + vlEsc(typeLabel) + '</div>'
+                                + '<div class="matrix-vl-item-sub">' + sub + '</div></div>'
+                                + '<div class="matrix-vl-item-r"><div class="matrix-vl-age"></div>'
+                                + '<div class="matrix-vl-exp"></div></div>'));
+                    });
+                    $("#matrix-vl-empty").toggle(!(data.verifications || []).length);
+                    if(data.hidden > 0) {
+                        $("#matrix-vl-more").text(data.hidden + " older request" + (data.hidden === 1 ? "" : "s") + " hidden.").show();
+                    } else {
+                        $("#matrix-vl-more").hide();
+                    }
+                    vlTick();
+                };
+                var vlLoadList = function() {
+                    vlCall({ id: vlId(), action: "list" })
+                        .done(vlRenderList)
+                        .fail(function() { vlRenderList({ result: "error", message: "Request failed — is Node-RED still running?" }); });
+                };
+                var vlShowList = function() {
+                    vlClearTimers();
+                    $("#matrix-vl-overlay").data("vlConfirmed", false);
+                    $("#matrix-vl-detailview").hide();
+                    $("#matrix-vl-listview").show();
+                    $("#matrix-vl-back,#matrix-vl-cancel").hide();
+                    $("#matrix-vl-items").html('<div class="matrix-vl-empty">Loading…</div>');
+                    $("#matrix-vl-empty,#matrix-vl-more").hide();
+                    vlLoadList();
+                    vlListTimer = setInterval(vlLoadList, 5000);
+                    vlTickTimer = setInterval(vlTick, 1000);
+                };
+
+                var vlRenderSas = function(sas) {
+                    var $sas = $("#matrix-vl-d-sas").empty();
+                    if(sas.emoji && sas.emoji.length) {
+                        sas.emoji.forEach(function(pair) {
+                            $sas.append('<div class="matrix-vl-emoji"><div class="e">' + vlEsc(pair[0])
+                                + '</div><div class="n">' + vlEsc(pair[1]) + '</div></div>');
+                        });
+                    } else if(sas.decimal) {
+                        $sas.append('<div style="font-size:24px;font-family:monospace;">' + vlEsc(sas.decimal.join("  ")) + '</div>');
+                    }
+                };
+                var vlRenderDetail = function(v) {
+                    var typeLabel = v.type === "room" ? "Room verification" : "Device verification";
+                    var head = vlEsc(typeLabel);
+                    if(v.userId) { head += " &mdash; " + vlEsc(v.userId); }
+                    if(v.deviceId) { head += " (device " + vlEsc(v.deviceId) + ")"; }
+                    $("#matrix-vl-d-head").html(head);
+
+                    if(v.phase === "done") {
+                        vlClearTimers();
+                        vlState("fa-check-circle", "#3a9a4e", "<b>Verified.</b> This session is now verified.");
+                        $("#matrix-vl-d-sas,#matrix-vl-d-actions").hide();
+                        $("#matrix-vl-cancel").hide();
+                        return;
+                    }
+                    if(v.phase === "cancelled") {
+                        vlClearTimers();
+                        var why = v.cancellationCode ? (" (" + vlEsc(v.cancellationCode) + ")") : "";
+                        vlState("fa-times-circle", "#c9302c", "Verification was cancelled" + why + ".");
+                        $("#matrix-vl-d-sas,#matrix-vl-d-actions").hide();
+                        $("#matrix-vl-cancel").hide();
+                        return;
+                    }
+                    if(v.phase === "gone") {
+                        vlClearTimers();
+                        vlState("fa-exclamation-triangle", "#888", "This verification is no longer available.");
+                        $("#matrix-vl-d-sas,#matrix-vl-d-actions").hide();
+                        $("#matrix-vl-cancel").hide();
+                        return;
+                    }
+                    if($("#matrix-vl-overlay").data("vlConfirmed")) {
+                        $("#matrix-vl-d-sas,#matrix-vl-d-actions").hide();
+                        vlState("fa-spinner fa-spin", "#888", "Waiting for the other device to confirm…");
+                        return;
+                    }
+                    if(v.sas && (v.sas.emoji || v.sas.decimal)) {
+                        vlState("fa-key", "#d18a1b", "Compare these emoji with the other device, then choose below.");
+                        vlRenderSas(v.sas);
+                        $("#matrix-vl-d-sas,#matrix-vl-d-actions").show();
+                        return;
+                    }
+                    $("#matrix-vl-d-sas,#matrix-vl-d-actions").hide();
+                    vlState("fa-spinner fa-spin", "#888", "Waiting for the verification to start…");
+                };
+                var vlPollDetail = function() {
+                    vlCall({ id: vlId(), action: "advance", verificationId: vlCurId() })
+                        .done(function(data) {
+                            if(data.result !== "ok") {
+                                vlState("fa-exclamation-triangle", "#c9302c", vlEsc(data.message));
+                                return;
+                            }
+                            vlRenderDetail(data.verification);
+                        })
+                        .fail(function() { vlState("fa-exclamation-triangle", "#c9302c", "Request failed — is Node-RED still running?"); });
+                };
+                var vlShowDetail = function(vid) {
+                    vlClearTimers();
+                    $("#matrix-vl-overlay").data("vlCurrentId", vid).data("vlConfirmed", false);
+                    $("#matrix-vl-listview").hide();
+                    $("#matrix-vl-detailview").show();
+                    $("#matrix-vl-d-sas,#matrix-vl-d-actions,#matrix-vl-d-result").hide();
+                    $("#matrix-vl-d-head").text("");
+                    vlState("fa-spinner fa-spin", "#888", "Starting verification…");
+                    $("#matrix-vl-back,#matrix-vl-cancel").show();
+                    vlPollDetail();
+                    vlDetailTimer = setInterval(vlPollDetail, 1500);
+                };
+
+                var vlClose = function() { vlClearTimers(); $("#matrix-vl-overlay").fadeOut(120); };
+
+                $("#matrix-vl-x,#matrix-vl-close").on("click", vlClose);
+                $("#matrix-vl-overlay").on("mousedown", function(e) { if(e.target === this) { vlClose(); } });
+                $(document).on("keydown.matrixvl", function(e) {
+                    if(e.key === "Escape" && $("#matrix-vl-overlay").is(":visible")) { vlClose(); }
+                });
+                $("#matrix-vl-back").on("click", vlShowList);
+                $("#matrix-vl-items").on("click", ".matrix-vl-item", function() {
+                    vlShowDetail($(this).attr("data-vid"));
+                });
+                $("#matrix-vl-cancel").on("click", function() {
+                    vlCall({ id: vlId(), action: "cancel", verificationId: vlCurId() }).always(vlPollDetail);
+                });
+                $("#matrix-vl-d-confirm").on("click", function() {
+                    $("#matrix-vl-overlay").data("vlConfirmed", true);
+                    $("#matrix-vl-d-sas,#matrix-vl-d-actions").hide();
+                    vlState("fa-spinner fa-spin", "#888", "Confirming…");
+                    vlCall({ id: vlId(), action: "confirm", verificationId: vlCurId() })
+                        .done(function(data) {
+                            if(data.result !== "ok") {
+                                $("#matrix-vl-overlay").data("vlConfirmed", false);
+                                vlState("fa-exclamation-triangle", "#c9302c", vlEsc(data.message));
+                                $("#matrix-vl-d-actions").show();
+                            }
+                        });
+                });
+                $("#matrix-vl-d-mismatch").on("click", function() {
+                    $("#matrix-vl-d-actions").hide();
+                    vlState("fa-spinner fa-spin", "#888", "Cancelling…");
+                    vlCall({ id: vlId(), action: "mismatch", verificationId: vlCurId() }).always(vlPollDetail);
+                });
+
+                $("#matrix-vl-overlay").data("vlShowListFn", vlShowList);
+                $("#matrix-vl-overlay").data("vlShowDetailFn", vlShowDetail);
+            }
+
+            $("#matrix-verification-list-btn").on("click", function() {
+                $("#matrix-vl-overlay").data("matrixNodeId", nodeId).fadeIn(120);
+                $("#matrix-vl-overlay").data("vlShowListFn")();
+            });
+
+            // --- Sessions (modal) ---
+            // Built once and reused; the node id is stored on the overlay.
+            if (!document.getElementById("matrix-ss-overlay")) {
+                $('<style>'
+                    + '.matrix-ss-overlay{position:fixed;inset:0;z-index:3000;display:none;background:rgba(0,0,0,.45);}'
+                    + '.matrix-ss-modal{position:absolute;top:50%;left:50%;transform:translate(-50%,-50%);'
+                    + 'width:560px;max-width:92vw;max-height:88vh;display:flex;flex-direction:column;'
+                    + 'border-radius:6px;overflow:hidden;box-shadow:0 12px 44px rgba(0,0,0,.45);'
+                    + 'background:var(--red-ui-primary-background,#fff);color:var(--red-ui-primary-text-color,#2a2a2a);}'
+                    + '.matrix-ss-head{display:flex;justify-content:space-between;align-items:center;'
+                    + 'padding:12px 16px;font-size:15px;font-weight:bold;'
+                    + 'background:var(--red-ui-secondary-background,#f3f3f3);'
+                    + 'border-bottom:1px solid var(--red-ui-secondary-border-color,#ddd);}'
+                    + '.matrix-ss-x{cursor:pointer;font-size:20px;line-height:1;opacity:.55;}'
+                    + '.matrix-ss-x:hover{opacity:1;}'
+                    + '.matrix-ss-body{padding:14px 16px;overflow:auto;}'
+                    + '.matrix-ss-h{font-weight:bold;font-size:12px;text-transform:uppercase;'
+                    + 'letter-spacing:.04em;color:var(--red-ui-secondary-text-color,#888);margin:2px 0 8px;}'
+                    + '.matrix-ss-h.spaced{margin-top:20px;}'
+                    + '.matrix-ss-item{display:flex;align-items:center;gap:10px;padding:10px 12px;'
+                    + 'margin-bottom:8px;border-radius:5px;cursor:pointer;'
+                    + 'border:1px solid var(--red-ui-secondary-border-color,#ddd);'
+                    + 'background:var(--red-ui-secondary-background,#f7f7f7);}'
+                    + '.matrix-ss-item:hover{border-color:var(--red-ui-node-border,#999);}'
+                    + '.matrix-ss-item-l{flex:1;min-width:0;}'
+                    + '.matrix-ss-item-title{font-weight:bold;word-break:break-word;}'
+                    + '.matrix-ss-item-sub{font-size:12px;color:var(--red-ui-secondary-text-color,#888);'
+                    + 'margin-top:2px;word-break:break-word;}'
+                    + '.matrix-ss-shield{font-size:20px;width:22px;text-align:center;flex-shrink:0;}'
+                    + '.matrix-ss-box{display:flex;gap:10px;align-items:flex-start;margin:10px 0;'
+                    + 'padding:10px 12px;border-radius:4px;font-size:13px;line-height:1.45;}'
+                    + '.matrix-ss-box.ok{background:#e7f4ea;border:1px solid #8fcea5;color:#1e6b33;}'
+                    + '.matrix-ss-box.err{background:#fde7e9;border:1px solid #e8a0a8;color:#8a1f2b;}'
+                    + '.matrix-ss-box .fa{font-size:18px;margin-top:1px;}'
+                    + '.matrix-ss-details div{display:flex;font-size:13px;padding:5px 0;'
+                    + 'border-bottom:1px solid var(--red-ui-secondary-border-color,#eee);}'
+                    + '.matrix-ss-details .k{width:130px;flex-shrink:0;color:var(--red-ui-secondary-text-color,#888);}'
+                    + '.matrix-ss-details .v{word-break:break-all;}'
+                    + '.matrix-ss-empty,.matrix-ss-more{font-size:13px;'
+                    + 'color:var(--red-ui-secondary-text-color,#888);padding:6px 2px;}'
+                    + '.matrix-ss-removelink{color:#c9302c;cursor:pointer;font-weight:bold;}'
+                    + '.matrix-ss-result{margin-top:12px;padding:10px 12px;border-radius:4px;font-size:13px;}'
+                    + '.matrix-ss-result.ok{background:#e7f4ea;border:1px solid #8fcea5;color:#1e6b33;}'
+                    + '.matrix-ss-result.err{background:#fde7e9;border:1px solid #e8a0a8;color:#8a1f2b;}'
+                    + '.matrix-ss-foot{display:flex;align-items:center;gap:8px;padding:10px 16px;'
+                    + 'background:var(--red-ui-secondary-background,#f3f3f3);'
+                    + 'border-top:1px solid var(--red-ui-secondary-border-color,#ddd);}'
+                    + '</style>').appendTo("head");
+
+                $('<div id="matrix-ss-overlay" class="matrix-ss-overlay"><div class="matrix-ss-modal">'
+                    + '<div class="matrix-ss-head"><span><i class="fa fa-desktop"></i> Sessions</span>'
+                    + '<span class="matrix-ss-x" id="matrix-ss-x" title="Close">&times;</span></div>'
+                    + '<div class="matrix-ss-body">'
+                    + '<div id="matrix-ss-listview">'
+                    + '<div class="matrix-ss-h">Current session</div>'
+                    + '<div id="matrix-ss-current"></div>'
+                    + '<div id="matrix-ss-currentmsg"></div>'
+                    + '<div class="matrix-ss-h spaced">Other sessions</div>'
+                    + '<div id="matrix-ss-others"></div>'
+                    + '<div id="matrix-ss-others-empty" class="matrix-ss-empty" style="display:none;">No other sessions.</div>'
+                    + '<div id="matrix-ss-more" class="matrix-ss-more" style="display:none;"></div>'
+                    + '</div>'
+                    + '<div id="matrix-ss-detailview" style="display:none;">'
+                    + '<div style="display:flex;justify-content:space-between;align-items:center;gap:10px;">'
+                    + '<div id="matrix-ss-d-name" style="font-size:15px;font-weight:bold;word-break:break-word;"></div>'
+                    + '<button type="button" class="red-ui-button" id="matrix-ss-d-rename">Rename</button></div>'
+                    + '<div id="matrix-ss-d-status"></div>'
+                    + '<div class="matrix-ss-h spaced">Session details</div>'
+                    + '<div id="matrix-ss-d-details" class="matrix-ss-details"></div>'
+                    + '<div id="matrix-ss-d-verifywrap" style="display:none;margin-top:14px;">'
+                    + '<button type="button" class="red-ui-button" id="matrix-ss-d-verify">Verify this session</button></div>'
+                    + '<div id="matrix-ss-d-removewrap" style="display:none;margin-top:16px;">'
+                    + '<span class="matrix-ss-removelink" id="matrix-ss-d-removelink">Remove this session</span>'
+                    + '<div id="matrix-ss-d-removeconfirm" style="display:none;margin-top:8px;">'
+                    + '<div style="background:#fdf3e7;border:1px solid #f0c36d;color:#7a5b16;border-radius:4px;'
+                    + 'padding:8px 10px;font-size:13px;margin-bottom:8px;">Removing a session signs it out. '
+                    + 'Enter the account password to confirm.</div>'
+                    + '<input type="password" id="matrix-ss-d-password" placeholder="Account password" '
+                    + 'style="width:100%;box-sizing:border-box;padding:7px 9px;border-radius:4px;'
+                    + 'border:1px solid var(--red-ui-form-input-border-color,#ccc);'
+                    + 'background:var(--red-ui-form-input-background,#fff);color:var(--red-ui-primary-text-color,#2a2a2a);">'
+                    + '<div style="text-align:right;margin-top:8px;"><button type="button" class="red-ui-button" '
+                    + 'id="matrix-ss-d-removeconfirmbtn">Confirm removal</button></div>'
+                    + '</div></div>'
+                    + '<div id="matrix-ss-d-result" class="matrix-ss-result" style="display:none;"></div>'
+                    + '</div>'
+                    + '</div>'
+                    + '<div class="matrix-ss-foot">'
+                    + '<button type="button" class="red-ui-button" id="matrix-ss-back" style="display:none;">&larr; Back</button>'
+                    + '<span style="flex:1;"></span>'
+                    + '<button type="button" class="red-ui-button" id="matrix-ss-close">Close</button>'
+                    + '</div></div></div>').appendTo(document.body);
+
+                var ssEsc = function(s) { return $("<div>").text(s == null ? "" : String(s)).html(); };
+                var ssId = function() { return $("#matrix-ss-overlay").data("matrixNodeId"); };
+                var ssCall = function(body) {
+                    return $.ajax({
+                        url: "matrix-chat/sessions", type: "POST",
+                        contentType: "application/json", data: JSON.stringify(body),
+                    });
+                };
+                var ssRelative = function(ts) {
+                    if(!ts) { return "activity unknown"; }
+                    var days = Math.floor((Date.now() - ts) / 86400000);
+                    if(days <= 0) { return "active today"; }
+                    if(days === 1) { return "active yesterday"; }
+                    if(days < 90) { return "active " + days + " days ago"; }
+                    return "inactive for 90+ days";
+                };
+                var ssFullDate = function(ts) {
+                    return ts ? new Date(ts).toLocaleString() : "unknown";
+                };
+                var ssShield = function(verified) {
+                    return '<i class="fa fa-shield matrix-ss-shield" style="color:'
+                        + (verified ? '#3a9a4e' : '#c9302c') + ';" title="'
+                        + (verified ? 'Verified' : 'Not verified') + '"></i>';
+                };
+                var ssCard = function(d, isCurrent) {
+                    var sub = (d.verified ? 'Verified' : 'Not verified')
+                        + ' · ' + ssRelative(d.lastSeenTs)
+                        + (d.lastSeenIp ? (' · ' + d.lastSeenIp) : '');
+                    return $('<div class="matrix-ss-item">')
+                        .data("device", d).data("isCurrent", isCurrent)
+                        .html(ssShield(d.verified)
+                            + '<div class="matrix-ss-item-l"><div class="matrix-ss-item-title">'
+                            + ssEsc(d.displayName || d.deviceId) + '</div>'
+                            + '<div class="matrix-ss-item-sub">' + ssEsc(sub) + '</div></div>'
+                            + '<i class="fa fa-angle-right" style="opacity:.5;"></i>');
+                };
+                var ssResult = function(ok, text) {
+                    $("#matrix-ss-d-result").removeClass("ok err").addClass(ok ? "ok" : "err").text(text).show();
+                };
+                var ssRenderList = function(data) {
+                    if(data.result !== "ok") {
+                        $("#matrix-ss-current").html('<div class="matrix-ss-empty">' + ssEsc(data.message) + '</div>');
+                        $("#matrix-ss-currentmsg,#matrix-ss-others").empty();
+                        $("#matrix-ss-others-empty,#matrix-ss-more").hide();
+                        return;
+                    }
+                    $("#matrix-ss-current").empty().append(ssCard(data.current, true));
+                    $("#matrix-ss-currentmsg").html(data.current.verified
+                        ? '<div class="matrix-ss-box ok"><i class="fa fa-shield"></i><div><b>Verified session</b><br>'
+                            + 'This session is cross-signed and ready for secure messaging.</div></div>'
+                        : '<div class="matrix-ss-box err"><i class="fa fa-shield"></i><div><b>Not verified</b><br>'
+                            + 'This session is not cross-signed. Use the Set up secure backup &amp; cross-signing '
+                            + 'button to verify it.</div></div>');
+                    var $others = $("#matrix-ss-others").empty();
+                    (data.others || []).forEach(function(d) { $others.append(ssCard(d, false)); });
+                    $("#matrix-ss-others-empty").toggle(!(data.others || []).length);
+                    if(data.hidden > 0) {
+                        $("#matrix-ss-more").text(data.hidden + " more session" + (data.hidden === 1 ? "" : "s") + " hidden.").show();
+                    } else {
+                        $("#matrix-ss-more").hide();
+                    }
+                };
+                var ssShowList = function() {
+                    $("#matrix-ss-detailview").hide();
+                    $("#matrix-ss-listview").show();
+                    $("#matrix-ss-back").hide();
+                    $("#matrix-ss-current").html('<div class="matrix-ss-empty">Loading…</div>');
+                    $("#matrix-ss-currentmsg,#matrix-ss-others").empty();
+                    $("#matrix-ss-others-empty,#matrix-ss-more").hide();
+                    ssCall({ id: ssId(), action: "list" })
+                        .done(ssRenderList)
+                        .fail(function() { ssRenderList({ result: "error", message: "Request failed — is Node-RED still running?" }); });
+                };
+                var ssDetailRow = function(k, v) {
+                    return '<div><span class="k">' + ssEsc(k) + '</span><span class="v">' + ssEsc(v) + '</span></div>';
+                };
+                var ssShowDetail = function(d, isCurrent) {
+                    $("#matrix-ss-overlay").data("ssDevice", d).data("ssIsCurrent", isCurrent);
+                    $("#matrix-ss-listview").hide();
+                    $("#matrix-ss-detailview").show();
+                    $("#matrix-ss-back").show();
+                    $("#matrix-ss-d-result,#matrix-ss-d-removeconfirm").hide();
+                    $("#matrix-ss-d-name").text(d.displayName || d.deviceId);
+                    $("#matrix-ss-d-status").html(d.verified
+                        ? '<div class="matrix-ss-box ok"><i class="fa fa-shield"></i><div><b>Verified session</b><br>'
+                            + 'This session is ready for secure messaging.</div></div>'
+                        : '<div class="matrix-ss-box err"><i class="fa fa-shield"></i><div><b>Not verified</b><br>'
+                            + (isCurrent
+                                ? 'This session is not cross-signed. Use the Set up secure backup &amp; cross-signing button to verify it.'
+                                : 'Verify this session to confirm it is trusted.')
+                            + '</div></div>');
+                    $("#matrix-ss-d-details").html(
+                        ssDetailRow("Session ID", d.deviceId)
+                        + ssDetailRow("Last activity", ssFullDate(d.lastSeenTs))
+                        + ssDetailRow("IP address", d.lastSeenIp || "unknown"));
+                    $("#matrix-ss-d-verifywrap").toggle(!isCurrent && !d.verified);
+                    $("#matrix-ss-d-removewrap").toggle(!isCurrent);
+                };
+                var ssClose = function() { $("#matrix-ss-overlay").fadeOut(120); };
+
+                $("#matrix-ss-x,#matrix-ss-close").on("click", ssClose);
+                $("#matrix-ss-overlay").on("mousedown", function(e) { if(e.target === this) { ssClose(); } });
+                $(document).on("keydown.matrixss", function(e) {
+                    if(e.key === "Escape" && $("#matrix-ss-overlay").is(":visible")) { ssClose(); }
+                });
+                $("#matrix-ss-back").on("click", ssShowList);
+                $("#matrix-ss-current,#matrix-ss-others").on("click", ".matrix-ss-item", function() {
+                    ssShowDetail($(this).data("device"), $(this).data("isCurrent"));
+                });
+                $("#matrix-ss-d-rename").on("click", function() {
+                    var d = $("#matrix-ss-overlay").data("ssDevice");
+                    var name = prompt("Session display name:", d.displayName || "");
+                    if(name === null) { return; }
+                    ssCall({ id: ssId(), action: "rename", deviceId: d.deviceId, displayName: name })
+                        .done(function(r) {
+                            if(r.result !== "ok") { ssResult(false, r.message); return; }
+                            d.displayName = name;
+                            $("#matrix-ss-d-name").text(name || d.deviceId);
+                            ssResult(true, "Session renamed.");
+                        })
+                        .fail(function() { ssResult(false, "Request failed."); });
+                });
+                $("#matrix-ss-d-verify").on("click", function() {
+                    var d = $("#matrix-ss-overlay").data("ssDevice");
+                    $("#matrix-ss-d-result").removeClass("ok err").html('<i class="fa fa-spinner fa-spin"></i> Starting verification…').show();
+                    ssCall({ id: ssId(), action: "verify", deviceId: d.deviceId })
+                        .done(function(r) {
+                            if(r.result !== "ok" || !r.verificationId) {
+                                ssResult(false, r.message || "Could not start verification.");
+                                return;
+                            }
+                            // hand off to the verification modal's detail view
+                            $("#matrix-ss-overlay").fadeOut(120);
+                            $("#matrix-vl-overlay").data("matrixNodeId", ssId()).fadeIn(120);
+                            $("#matrix-vl-overlay").data("vlShowDetailFn")(r.verificationId);
+                        })
+                        .fail(function() { ssResult(false, "Request failed."); });
+                });
+                $("#matrix-ss-d-removelink").on("click", function() {
+                    $("#matrix-ss-d-password").val("");
+                    $("#matrix-ss-d-removeconfirm").show();
+                });
+                $("#matrix-ss-d-removeconfirmbtn").on("click", function() {
+                    var d = $("#matrix-ss-overlay").data("ssDevice");
+                    $("#matrix-ss-d-result").removeClass("ok err").html('<i class="fa fa-spinner fa-spin"></i> Removing session…').show();
+                    ssCall({ id: ssId(), action: "remove", deviceId: d.deviceId, password: $("#matrix-ss-d-password").val() })
+                        .done(function(r) {
+                            if(r.result !== "ok") { ssResult(false, r.message); return; }
+                            ssShowList();
+                        })
+                        .fail(function() { ssResult(false, "Request failed."); });
+                });
+
+                $("#matrix-ss-overlay").data("ssShowListFn", ssShowList);
+            }
+
+            $("#matrix-sessions-btn").on("click", function() {
+                $("#matrix-ss-overlay").data("matrixNodeId", nodeId).fadeIn(120);
+                $("#matrix-ss-overlay").data("ssShowListFn")();
+            });
+
+            // --- Login: fetch a fresh access token & device id ---
+            $("#matrix-login-btn").on("click", function() {
+                function prettyPrintJson(json) {
+                    try { return typeof json === 'object' ? JSON.stringify(json, null, 2) : json; }
+                    catch (error) { return json; }
+                }
+                let userId = $("#node-config-input-userId").val(),
+                    userPassword = $("#node-config-input-password").val(),
+                    serverUrl = $("#node-config-input-url").val();
+                if (!userId) { alert("User ID is required to fetch access token."); return; }
+                if (!userPassword) { alert("Password is required to fetch access token."); return; }
+                if (!serverUrl) { alert("Server URL is required to fetch access token."); return; }
+
+                $("#matrix-login-btn, #matrix-chat-login-error, #matrix-chat-login-success").hide();
+                $("#matrix-access-token-loader").show();
+                $.ajax({
+                    type: 'POST',
+                    url: 'matrix-chat/login',
+                    dataType: 'json',
+                    data: {
+                        'userId': userId,
+                        'password': userPassword,
+                        'baseUrl': serverUrl,
+                        'displayName': $("#node-config-input-deviceLabel").val(),
+                    }
+                }).then(
+                    function(data) {
+                        if (data.result && data.result === 'ok') {
+                            $("#matrix-chat-login-error").hide();
+                            $("#matrix-chat-login-success")
+                                .html("Login Successful! Auth Token and Device ID have been set below.")
+                                .show();
+                            $("#node-config-input-accessToken").val(data.token);
+                            $("#node-config-input-deviceId").val(data.device_id);
+                        } else if (data.result && data.result === 'error') {
+                            $("#matrix-chat-login-success").hide();
+                            $("#matrix-chat-login-error")
+                                .html(data.message ? ('Failed to login: <br />' + prettyPrintJson(data.message)) : 'Failed to login')
+                                .show();
+                        }
+                        $("#matrix-login-btn").show();
+                        $("#matrix-access-token-loader").hide();
+                    },
+                    function() {
+                        $("#matrix-chat-login-success").hide();
+                        $("#matrix-chat-login-error")
+                            .html("Failed to login due to server error communicating with Node-RED")
+                            .show();
+                        $("#matrix-login-btn").show();
+                        $("#matrix-access-token-loader").hide();
+                    }
+                );
+            });
         }
     });
 </script>
@@ -71,7 +820,10 @@
         <input type="password" placeholder="" id="node-config-input-password">
     </div>
     <div class="form-tips" style="margin-bottom: 12px;">
-        Password is never saved and is only used to fetch an access token using the button below.
+        Optional. Used to fetch an access token with the button below, and &mdash; if you
+        enable cross-signing &mdash; as a fallback when the homeserver requires the account
+        password to upload signing keys. If set, it is stored (encrypted) with the node's
+        credentials. Leave blank if you only want to use an access token.
     </div>
     <pre class="form-tips" id="matrix-chat-login-error" style="color: #721c24;background-color: #f8d7da;border-color: #f5c6cb;margin-bottom: 12px;display:none;"></pre>
     <pre class="form-tips" id="matrix-chat-login-success" style="color: #155724;background-color: #d4edda;border-color: #c3e6cb;margin-bottom: 12px;display:none;"></pre>
@@ -130,88 +882,87 @@
             <code style="white-space: normal;">let client = global.get("matrixClient['@bot:example.com']");</code>
         </div>
     </div>
-    <script type="text/javascript">
-        $("#matrix-login-btn").on("click", function() {
-            function prettyPrintJson(json) {
-                try{
-                    return typeof json === 'object' ? JSON.stringify(json, null, 2) : json;
-                }
-                catch (error){
-                    return json;
-                }
-            }
 
-            let userId = $("#node-config-input-userId").val(),
-                userPassword = $("#node-config-input-password").val(),
-                serverUrl = $("#node-config-input-url").val();
+    <div class="form-row">
+        <input
+                type="checkbox"
+                id="node-config-input-allowUnknownDevices"
+                style="width: auto; margin-left: 125px; vertical-align: top"
+        />
+        <label for="node-config-input-allowUnknownDevices" style="width: auto">
+            Allow unverified devices in rooms
+        </label>
+        <div class="form-tips" style="margin-bottom: 12px;">
+            Allow sending messages to a room with unknown devices which have not been verified.
+        </div>
+    </div>
 
-            if(!userId) {
-                alert("User ID is required to fetch access token.");
-                return;
-            }
-            if(!userPassword) {
-                alert("Password is required to fetch access token.");
-                return;
-            }
-            if(!serverUrl) {
-                alert("Server URL is required to fetch access token.");
-                return;
-            }
+    <div class="form-row">
+        <label><i class="fa fa-shield"></i> Secure Backup</label>
+        <button type="button" class="red-ui-button" id="matrix-secure-backup-btn">Set up secure backup &amp; cross-signing</button>
+    </div>
+    <div class="form-tips" style="margin-bottom: 12px;">
+        Sets up cross-signing so the bot's own device shows as verified. The server
+        configuration must be deployed and connected first.
+    </div>
 
-            $("#matrix-login-btn, #matrix-chat-login-error, #matrix-chat-login-success").hide();
-            $("#matrix-access-token-loader").show();
-            $.ajax({
-                type: 'POST',
-                url: 'matrix-chat/login',
-                dataType: 'json',
-                data: {
-                    'userId': userId,
-                    'password': userPassword,
-                    'baseUrl': serverUrl,
-                    'displayName': $("#node-config-input-deviceLabel").val(),
-                }
-            }).then(
-                function(data) {
-                    if(data.result && data.result === 'ok') {
-                        $("#matrix-chat-login-error").hide();
-                        $("#matrix-chat-login-success")
-                            .html("Login Successful! Auth Token and Device ID have been set below.")
-                            .show();
+    <div class="form-row">
+        <label><i class="fa fa-check-circle"></i> Verification</label>
+        <button type="button" class="red-ui-button" id="matrix-verification-list-btn">Pending verification requests</button>
+    </div>
+    <div class="form-tips" style="margin-bottom: 12px;">
+        Review and complete incoming device verification requests without building a flow.
+        The server configuration must be deployed and connected first.
+    </div>
 
-                        $("#node-config-input-accessToken").val(data.token);
-                        $("#node-config-input-deviceId").val(data.device_id);
-                    } else if(data.result && data.result === 'error') {
-                        $("#matrix-chat-login-success").hide();
-                        $("#matrix-chat-login-error")
-                            .html(data.message ? ('Failed to login: <br />' + prettyPrintJson(data.message)) : 'Failed to login')
-                            .show();
-                    }
-                    $("#matrix-login-btn").show();
-                    $("#matrix-access-token-loader").hide();
-                }, function() {
-                    $("#matrix-chat-login-success").hide();
-                    $("#matrix-chat-login-error")
-                        .html("Failed to login due to server error communicating with Node-RED")
-                        .show();
-                    $("#matrix-login-btn").show();
-                    $("#matrix-access-token-loader").hide();
-                }
-            );
-        });
-    </script>
+    <div class="form-row">
+        <label><i class="fa fa-desktop"></i> Sessions</label>
+        <button type="button" class="red-ui-button" id="matrix-sessions-btn">Manage sessions</button>
+    </div>
+    <div class="form-tips" style="margin-bottom: 12px;">
+        View the account's logged-in sessions, verify them, or remove ones you don't recognize.
+        The server configuration must be deployed and connected first.
+    </div>
 </script>
 
 <script type="text/html" data-help-name="matrix-server-config">
     <h3>Details</h3>
     <p>Matrix client connection configuration</p>
 
+    <h3>Server URL</h3>
+    <p>
+        The URL of your homeserver. You can enter either the homeserver URL directly
+        (e.g. <code>https://matrix.example.org</code>) or the delegating domain
+        (e.g. <code>https://example.org</code>) &mdash; in the latter case the real
+        homeserver is resolved automatically via <code>.well-known</code> discovery.
+    </p>
+
     <h3>Setting up an account</h3>
     <div>
         <p>
-            You need an account for your client to use. If you are going to be using End-to-End Encryption you should generate the bot and only use it within Node-RED otherwise if you have other clients connected on the same user it could cause problems with e2ee (key sharing is currently not supported).
+            You need an account for your client to use. For End-to-End Encryption it is simplest to dedicate the account to the bot and run it only within Node-RED. The account may also be signed in on other clients &mdash; if so, verify those sessions against the bot (see <em>Cross-signing &amp; secure backup</em> below) so they trust each other and share keys.
         </p>
         <p>If you have access to the server directly you can use Shared Secret Registration as described <a href="https://github.com/Skylar-Tech/node-red-contrib-matrix-chat/tree/master/examples#create-user-with-shared-secret-registration" target="_blank" style="text-decoration: underline;">here</a>.</p>
         <p>If this is a server you do not administrate/have access to follow these instructions:</p>
-        <ol><li>In a private/incognito browser window, open Element.</li><li>Log in to the account you want to get the access token for, such as the bot's account. <strong>Do not setup key storage</strong>.</li><li>Click on the bot's name in the top left corner then "Settings".</li><li>(Optional) Set your bot's display name and avatar.</li><li>Click the "Help &amp; About" tab (left side of the dialog).</li><li>Scroll to the bottom and click the <code>&lt;click to reveal&gt;</code> part of <code>Access Token: &lt;click to reveal&gt;</code>.</li><li>Copy your access token to a safe place, like the bot's configuration file.</li><li><strong>Do not log out.</strong> Instead, just close the window. If you used a private browsing session, you should be able to still use Element for your own account. Logging out deletes the access token from the server, making the bot unable to use it.</li></ol>
+        <ol><li>In a private/incognito browser window, open Element.</li><li>Log in to the account you want to get the access token for, such as the bot's account.</li><li>Click on the bot's name in the top left corner then "Settings".</li><li>(Optional) Set your bot's display name and avatar.</li><li>Click the "Help &amp; About" tab (left side of the dialog).</li><li>Scroll to the bottom and click the <code>&lt;click to reveal&gt;</code> part of <code>Access Token: &lt;click to reveal&gt;</code>.</li><li>Copy your access token to a safe place, like the bot's configuration file.</li><li><strong>Do not log out.</strong> Instead, just close the window. If you used a private browsing session, you should be able to still use Element for your own account. Logging out deletes the access token from the server, making the bot unable to use it.</li></ol>
+    </div>
+
+    <h3>Cross-signing &amp; secure backup</h3>
+    <div>
+        <p>
+            Use the <strong>Set up secure backup &amp; cross-signing</strong> button to set up
+            cross-signing so the bot's own device is verified. The server configuration must be
+            deployed and connected first; the button then checks the account and, interactively:
+        </p>
+        <ul>
+            <li>if the account already has a secure backup, lets you <strong>unlock</strong> it with its recovery key (or passphrase) and set up cross-signing for the bot;</li>
+            <li>otherwise (or on request) lets you <strong>reset</strong> cross-signing and secure backup, creating a new recovery key &mdash; this needs the account password.</li>
+        </ul>
+        <p>
+            To verify other devices interactively (SAS emoji), use the <code>matrix-verification</code>
+            node to receive verification requests and <code>matrix-verification-action</code> to
+            accept, start, confirm or cancel them. This lets you build your own approval flow
+            (for example emailing the emoji for a human to confirm).
+        </p>
     </div>
 </script>

src/matrix-upload-file.html

@@ -105,59 +105,69 @@
 
 <script type="text/html" data-help-name="matrix-upload-file">
     <h3>Details</h3>
-    <p>Upload a file to the matrix homeserver. Returns a payload that can then be chained to a Send Message node to post the file to a room, or you can use the mxc_url to update a user or room avatar.</p>
+    <p>Upload a file to the Matrix homeserver. Returns a payload that can then be chained to a Send Message node to post the file to a room, or you can use the mxc_url to update a user or room avatar. The node supports uploading files, auto-detecting their types, and generating optional thumbnails for images and videos. Encrypted uploads are also supported.</p>
 
     <h3>Inputs</h3>
     <dl class="message-properties">
         <dt>msg.payload
             <span class="property-type">string | Buffer</span>
         </dt>
-        <dd> If this is not a buffer it assumes it is a path to the file. </dd>
+        <dd> A path to the file (string) or a file buffer (Buffer) to upload. If a buffer is provided, you must specify the filename for accurate type detection.</dd>
 
-        <dt>msg.topic
+        <dt>msg.filename
             <span class="property-type">string</span>
         </dt>
-        <dd> Room ID to send file to. Ignored if configured on the node, otherwise required.</dd>
+        <dd> The name of the file to upload. If not provided, the filename is auto-detected from the path, but this may lead to inaccuracies in file type detection.</dd>
 
-        <dt class="optional">msg.filename
+        <dt>msg.body
             <span class="property-type">string | null</span>
         </dt>
-        <dd> name of the file to upload. You REALLY should pass this if you want the file type to be detected correctly. If no filename is provided it will be auto-detected but note that this is not perfect (for example: .doc word files are detected incorrectly as application/x-cfb) and only works with binary files.</dd>
-
-        <dt class="optional">msg.body
-            <span class="property-type">string | null</span>
-        </dt>
-        <dd> this will be the display name the client will see when rendered in their chat client. If this is left empty it will just display as "Attachment".</dd>
+        <dd> The display name for the file when rendered in the chat. If left empty, the default display name is "Attachment".</dd>
 
         <dt class="optional">msg.contentType
             <span class="property-type">string | null</span>
         </dt>
-        <dd> Content <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types" target="_blank">MIME Type</a>. If set this forces the mime type. If you do not provide this it will try to be auto-detected.</dd>
+        <dd> Optional MIME Type of the file. If not provided, the type will be auto-detected based on the filename or buffer. If the detection fails, it will default to "text/plain".</dd>
 
-        <dt class="optional">msg.content
-            <span class="property-type">object | null</span>
+        <dt class="optional">msg.encrypted
+            <span class="property-type">boolean</span>
         </dt>
-        <dd> craft your own msg.content to send to the server. If defined then <code>msg.filename</code>, <code>msg.contentType</code>, <code>msg.body</code>, and <code>msg.payload</code> aren't required since the file already exists.</dd>
+        <dd> Set to true if the file should be uploaded with encryption. The node handles encryption automatically if this is enabled.</dd>
+
+        <dt class="optional">msg.generateThumbnails
+            <span class="property-type">boolean</span>
+        </dt>
+        <dd> Set to true to generate thumbnails for image or video uploads. Thumbnails are generated automatically for supported types.</dd>
     </dl>
 
     <h3>Outputs</h3>
     <ol class="node-ports">
         <li>Success
             <dl class="message-properties">
+                <dt>msg.payload <span class="property-type">object</span></dt>
+                <dd>An object containing details of the uploaded file, including the URL (mxc URI), the MIME type, size, and any generated thumbnail information.</dd>
+
                 <dt>msg.eventId <span class="property-type">string</span></dt>
-                <dd>the eventId from the posted message.</dd>
+                <dd>The eventId of the uploaded file message.</dd>
             </dl>
         </li>
         <li>Error
             <dl class="message-properties">
                 <dt>msg.error <span class="property-type">string</span></dt>
-                <dd>the error that occurred.</dd>
+                <dd>A description of the error that occurred during the upload.</dd>
             </dl>
         </li>
     </ol>
 
+    <h3>Additional Notes</h3>
+    <ul>
+        <li>The node supports generating thumbnails for images and video files if configured. For videos, the thumbnail is generated from the first frame.</li>
+        <li>Encrypted uploads require no additional configuration beyond setting msg.encrypted to true. The node handles encryption and returns the necessary decryption information.</li>
+        <li>The file type is auto-detected based on the filename or the content buffer. You can override this by setting the msg.contentType manually.</li>
+    </ul>
+
     <h3>References</h3>
     <ul>
         <li><a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types">MIME Types</a> - description of <code>msg.contentType</code> format</li>
     </ul>
-</script>
+</script>

src/matrix-upload-file.js

@@ -1,5 +1,6 @@
 const crypto = require("isomorphic-webcrypto");
 const ffmpeg = require('fluent-ffmpeg');
+const sharp = require('sharp');
 const getImageSize = require('image-size');
 const tmp = require('tmp');
 const fs = require('fs');
@@ -35,274 +36,336 @@ module.exports = function(RED) {
             node.status({ fill: "green", shape: "ring", text: "connected" });
         });
 
-        async function detectFileType(filename, bufferOrPath)
-        {
+        async function detectFileType(filename, bufferOrPath, msg) {
             const Mime = require('mime');
             let file = Buffer.isBuffer(bufferOrPath) ? filename : bufferOrPath;
 
-            if(file)
-            {
-                let type = Mime.getType(file);
-                let ext = Mime.getExtension(file);
-                if(type) {
-                    return {ext: ext, mime: type}
+            try {
+                if(file) {
+                    let type = Mime.getType(file);
+                    let ext = Mime.getExtension(file);
+                    if(type) {
+                        return {ext: ext, mime: type};
+                    }
                 }
+            } catch (error) {
+                node.error(`Error detecting file type for ${filename}: ${error.message}`, msg);
             }
+            return null;
         }
 
-        function getFileBuffer(data)
-        {
-            if(Buffer.isBuffer(data)) {
-                return data;
-            }
+        function getFileBuffer(data, msg) {
+            try {
+                if (Buffer.isBuffer(data)) {
+                    return data;
+                }
 
-            if (data && RED.settings.fileWorkingDirectory && !path.isAbsolute(data)) {
-                return fs.readFileSync(path.resolve(path.join(RED.settings.fileWorkingDirectory,data)));
+                if (data && RED.settings.fileWorkingDirectory && !path.isAbsolute(data)) {
+                    return fs.readFileSync(path.resolve(path.join(RED.settings.fileWorkingDirectory, data)));
+                }
+                return fs.readFileSync(data);
+            } catch (error) {
+                node.error(`Error reading file buffer: ${error.message}`, msg);
+                throw error;
             }
-            return fs.readFileSync(data);
         }
 
         function getToValue(msg, type, property) {
             let value = property;
-            if (type === "msg") {
-                value = RED.util.getMessageProperty(msg, property);
-            } else if ((type === 'flow') || (type === 'global')) {
-                try {
-                    value = RED.util.evaluateNodeProperty(property, type, node, msg);
-                } catch(e2) {
-                    throw new Error("Invalid value evaluation");
+            try {
+                if (type === "msg") {
+                    value = RED.util.getMessageProperty(msg, property);
+                } else if ((type === 'flow') || (type === 'global')) {
+                    try {
+                        value = RED.util.evaluateNodeProperty(property, type, node, msg);
+                    } catch(e2) {
+                        throw new Error("Invalid value evaluation");
+                    }
+                } else if(type === "bool") {
+                    value = (property === 'true');
+                } else if(type === "num") {
+                    value = Number(property);
                 }
-            } else if(type === "bool") {
-                value = (property === 'true');
-            } else if(type === "num") {
-                value = Number(property);
+            } catch (error) {
+                node.error(`Error evaluating value for type ${type}: ${error.message}`);
+                throw new Error("Invalid value evaluation");
             }
             return value;
         }
 
         node.on("input", onInput);
-        async function onInput(msg)
-        {
-            if (! node.server || ! node.server.matrixClient) {
-                node.warn("No matrix server selected");
-                return;
-            }
+        async function onInput(msg) {
+            try {
+                if (!node.server || !node.server.matrixClient) {
+                    node.warn("No matrix server selected");
+                    return;
+                }
 
-            if(!node.server.isConnected()) {
-                node.error("Matrix server connection is currently closed", msg);
-                msg.error = "Matrix server connection is currently closed";
-                node.send([null, msg]);
-                return;
-            }
-
-            let bufferOrPath = getToValue(msg, node.inputType, node.inputValue);
-            if(!bufferOrPath) {
-                node.error('Missing file path/buffer input', msg);
-                msg.error = 'Missing file path/buffer input';
-                node.send([null, msg]);
-                return;
-            }
-
-            let filename = getToValue(msg, node.fileNameType, node.fileNameValue);
-            if(!filename || typeof filename !== 'string') {
-                if(!Buffer.isBuffer(bufferOrPath)) {
-                    filename = path.basename(bufferOrPath);
-                } else {
-                    node.error('Missing filename, this is required if input is a file buffer', msg);
-                    msg.error = 'Missing filename, this is required if input is a file buffer';
+                if (!node.server.isConnected()) {
+                    node.error("Matrix server connection is currently closed", msg);
+                    msg.error = "Matrix server connection is currently closed";
                     node.send([null, msg]);
                     return;
                 }
-            }
 
-            msg.contentType = node.contentType || msg.contentType || null;
-            let detectedFileType = await detectFileType(filename, bufferOrPath);
-            node.log("Detected file type " + JSON.stringify(detectedFileType) + " for " + (Buffer.isBuffer(bufferOrPath) ? 'buffer' : `file ${bufferOrPath}`), msg);
-
-            let contentType = msg.contentType || detectedFileType?.mime || null,
-                msgtype = msg.msgtype || null;
-            if(!contentType) {
-                node.warn("Content-type failed to detect, falling back to text/plain", msg);
-                contentType = 'text/plain';
-            }
-            if(!msgtype) {
-                msgtype = autoDetectMatrixMessageType(detectedFileType);
-            }
-
-            let encryptedFile = null;
-            if(msg.encrypted) {
-                encryptedFile = await encryptAttachment(getFileBuffer(bufferOrPath));
-            }
-
-            node.log("Uploading file ", msg);
-            let file;
-            try {
-                file = await node.server.matrixClient.uploadContent(
-                    encryptedFile?.data || getFileBuffer(bufferOrPath),
-                {
-                        name: filename, // Name to give the file on the server.
-                        rawResponse: false, // Return the raw body, rather than parsing the JSON.
-                        type: contentType, // Content-type for the upload. Defaults to file.type, or applicaton/octet-stream.
-                        onlyContentUri: false // Just return the content URI, rather than the whole body. Defaults to false. Ignored if opts.rawResponse is true.
-                    });
-            } catch(e) {
-                node.error("Upload content error " + e);
-                msg.error = e;
-                node.send([null, msg]);
-                return;
-            }
-
-            // we call this method when we need a file and cannot use the buffer
-            // so if we get passed a buffer we write it to a tmp file and return that
-            // otherwise we just return the string because it's already a file
-            let tempFile = null;
-            function getFile(bufferOrFile) {
-                if(!Buffer.isBuffer(bufferOrFile)) {
-                    return bufferOrFile; // already a file
+                let bufferOrPath = getToValue(msg, node.inputType, node.inputValue);
+                if (!bufferOrPath) {
+                    node.error('Missing file path/buffer input', msg);
+                    msg.error = 'Missing file path/buffer input';
+                    node.send([null, msg]);
+                    return;
                 }
 
-                if(tempFile) {
-                    return tempFile;
+                let filename = getToValue(msg, node.fileNameType, node.fileNameValue);
+                if (!filename || typeof filename !== 'string') {
+                    if (!Buffer.isBuffer(bufferOrPath)) {
+                        filename = path.basename(bufferOrPath);
+                    } else {
+                        node.error('Missing filename, this is required if input is a file buffer', msg);
+                        msg.error = 'Missing filename, this is required if input is a file buffer';
+                        node.send([null, msg]);
+                        return;
+                    }
                 }
 
-                // write buffer to tmp file and return path
-                let tmpObj = tmp.fileSync({ postfix: `.${detectedFileType.ext}` });
-                fs.writeFileSync(tmpObj.name, bufferOrFile);
-                tempFile = tmpObj.name;
-                return tmpObj.name;
-            }
+                msg.contentType = node.contentType || msg.contentType || null;
+                let detectedFileType = await detectFileType(filename, bufferOrPath, msg);
+                node.log("Detected file type " + JSON.stringify(detectedFileType) + " for " + (Buffer.isBuffer(bufferOrPath) ? 'buffer' : `file ${bufferOrPath}`), msg);
 
-            function deleteTempFile() {
-                if(!tempFile) return null;
-                fs.rmSync(tempFile);
-            }
-
-            // get size of a buffer or file in bytes
-            function getFileSize(bufferOrPath) {
-                if(Buffer.isBuffer(bufferOrPath)) {
-                    return Buffer.byteLength(bufferOrPath);
+                let contentType = msg.contentType || detectedFileType?.mime || null,
+                    msgtype = msg.msgtype || null;
+                if (!contentType) {
+                    node.warn("Content-type failed to detect, falling back to text/plain", msg);
+                    contentType = 'text/plain';
+                }
+                if (!msgtype) {
+                    msgtype = autoDetectMatrixMessageType(detectedFileType);
                 }
 
-                return fs.statSync(bufferOrPath).size;
-            }
-
-            async function addThumbnail(buffer) {
-                let imageSize = getImageSize(Buffer.isBuffer(buffer) ? buffer : buffer.data);
-                msg.payload.info.thumbnail_info = {
-                    w: imageSize.width,
-                    h: imageSize.height,
-                    size: getFileSize(Buffer.isBuffer(buffer) ? buffer : buffer.data)
+                let encryptedFile = null;
+                if (msg.encrypted) {
+                    encryptedFile = await encryptAttachment(getFileBuffer(bufferOrPath, msg));
                 }
-                let uploadedThumbnail = await node.server.matrixClient.uploadContent(
-                    Buffer.isBuffer(buffer) ? buffer : buffer.data,
-                    {
-                        name: "thumbnail.png", // Name to give the file on the server.
-                        rawResponse: false, // Return the raw body, rather than parsing the JSON.
-                        type: "image/png", // Content-type for the upload. Defaults to file.type, or applicaton/octet-stream.
-                        onlyContentUri: false // Just return the content URI, rather than the whole body. Defaults to false. Ignored if opts.rawResponse is true.
-                    });
-                // delete local file
-                if(msg.encrypted) {
-                    msg.payload.info.thumbnail_file.url = uploadedThumbnail.content_uri;
-                } else {
-                    msg.payload.info.thumbnail_url = uploadedThumbnail.content_uri;
-                }
-            }
 
-            function _ffmpegVideoThumbnail(filepath){
-                return new Promise((resolve,reject) => {
-                    let filename = `${msg._msgid}-screenshot.png`;
-                    ffmpeg(filepath)
-                        .on('end', async function() {
-                            let path = `/tmp/${filename}`;
-                            let buffer = getFileBuffer(path);
-                            let encryptedThumbnail = null;
-                            if(msg.encrypted) {
-                                encryptedThumbnail = await encryptAttachment(buffer);
-                                msg.payload.info.thumbnail_file = encryptedFile.info;
-                            }
-                            try {
-                                await addThumbnail(encryptedThumbnail || buffer);
-                                fs.rmSync(path); // delete temporary thumbnail file
-                                resolve();
-                            } catch(e) {
-                                return reject(new Error("Thumbnail upload failure: " + e));
-                            }
-                        })
-                        .on('error', function(err) {
-                            return reject(err);
-                        })
-                        .screenshots({
-                            timestamps: [0],
-                            filename: filename,
-                            folder: '/tmp',
-                            size: '320x?'
+                node.log("Uploading file ", msg);
+                let file;
+                try {
+                    file = await node.server.matrixClient.uploadContent(
+                        encryptedFile?.data || getFileBuffer(bufferOrPath, msg),
+                        {
+                            name: filename, // Name to give the file on the server.
+                            rawResponse: false, // Return the raw body, rather than parsing the JSON.
+                            type: contentType, // Content-type for the upload. Defaults to file.type, or applicaton/octet-stream.
+                            onlyContentUri: false // Just return the content URI, rather than the whole body. Defaults to false. Ignored if opts.rawResponse is true.
                         });
-                });
-            }
-
-            msg.payload = {};
-            if(msg.encrypted) {
-                msg.payload.file = encryptedFile?.info || {};
-                msg.payload.file.url = file.content_uri;
-            } else {
-                msg.payload.url = file.content_uri;
-            }
-            msg.payload.msgtype = msgtype;
-            msg.payload.body = msg.body || msg.filename || "";
-            msg.payload.info = {
-                "mimetype": contentType,
-                "size": getFileSize(bufferOrPath),
-            };
-            if(msgtype === 'm.image') {
-                // detect size of image
-                try {
-                    let imageSize = getImageSize(buffer);
-                    msg.payload.info.h = imageSize.height;
-                    msg.payload.info.w = imageSize.width;
-                } catch(e) {
-                    node.error("Failed to get image size: " + e, msg);
-                }
-            } else if(msgtype === 'm.audio' && detectedFileType) {
-                try {
-                    // detect duration of audio clip
-                    let filepath = getFile(bufferOrPath);
-                    let metadata = await _ffprobe(filepath);
-                    let audioStream = metadata?.streams.filter(function(stream){return stream.codec_type === "audio" || false;})[0];
-                    if(audioStream?.duration) {
-                        msg.payload.info.duration = audioStream?.duration * 1000;
-                    }
-                } catch(e) {
-                    node.error(e, msg);
-                }
-                deleteTempFile();
-            } else if(msgtype === 'm.video' && detectedFileType) {
-                let filepath = getFile(bufferOrPath);
-
-                try {
-                    // detect duration & width/height of video clip
-                    let metadata = await _ffprobe(filepath);
-                    let videoStream = metadata?.streams.filter(function(stream){return stream.codec_type === "video" || false;})[0];
-                    if(videoStream) {
-                        msg.payload.info.duration = videoStream.duration * 1000;
-                        msg.payload.info.w = videoStream.width;
-                        msg.payload.info.h = videoStream.height;
-                    }
-                } catch(e) {
-                    node.error("ffprobe error: " + e);
+                } catch (e) {
+                    node.error("Upload content error " + e, msg);
+                    msg.error = e;
+                    node.send([null, msg]);
+                    return;
                 }
 
-                if(node.generateThumbnails) {
+                // we call this method when we need a file and cannot use the buffer
+                // so if we get passed a buffer we write it to a tmp file and return that
+                // otherwise we just return the string because it's already a file
+                let tempFile = null;
+
+                function getFile(bufferOrFile) {
                     try {
-                        await _ffmpegVideoThumbnail(filepath);
-                    } catch(e) {
-                        node.error("Screenshot generation error: " + e);
+                        if (!Buffer.isBuffer(bufferOrFile)) {
+                            return bufferOrFile; // already a file
+                        }
+
+                        if (tempFile) {
+                            return tempFile;
+                        }
+
+                        // write buffer to tmp file and return path
+                        let tmpObj = tmp.fileSync({postfix: `.${detectedFileType.ext}`});
+                        fs.writeFileSync(tmpObj.name, bufferOrFile);
+                        tempFile = tmpObj.name;
+                        return tmpObj.name;
+                    } catch (error) {
+                        node.error(`Error creating temp file: ${error.message}`, msg);
+                        throw error;
                     }
                 }
-                deleteTempFile();
-            }
 
-            node.send(msg, null);
+                function deleteTempFile() {
+                    if (!tempFile) return null;
+                    try {
+                        fs.rmSync(tempFile);
+                    } catch (error) {
+                        node.error(`Error deleting temp file: ${error.message}`, msg);
+                    }
+                }
+
+                // get size of a buffer or file in bytes
+                function getFileSize(bufferOrPath) {
+                    try {
+                        if (Buffer.isBuffer(bufferOrPath)) {
+                            return Buffer.byteLength(bufferOrPath);
+                        }
+
+                        return fs.statSync(bufferOrPath).size;
+                    } catch (error) {
+                        node.error(`Error getting file size: ${error.message}`, msg);
+                        throw error;
+                    }
+                }
+
+                async function addThumbnail(buffer) {
+                    try {
+                        let imageSize = getImageSize(Buffer.isBuffer(buffer) ? buffer : buffer.data);
+                        msg.payload.info.thumbnail_info = {
+                            w: imageSize.width,
+                            h: imageSize.height,
+                            size: getFileSize(Buffer.isBuffer(buffer) ? buffer : buffer.data)
+                        }
+                        let uploadedThumbnail = await node.server.matrixClient.uploadContent(
+                            Buffer.isBuffer(buffer) ? buffer : buffer.data,
+                            {
+                                name: "thumbnail.png", // Name to give the file on the server.
+                                rawResponse: false, // Return the raw body, rather than parsing the JSON.
+                                type: "image/png", // Content-type for the upload. Defaults to file.type, or applicaton/octet-stream.
+                                onlyContentUri: false // Just return the content URI, rather than the whole body. Defaults to false. Ignored if opts.rawResponse is true.
+                            });
+                        // delete local file
+                        if (msg.encrypted) {
+                            msg.payload.info.thumbnail_file.url = uploadedThumbnail.content_uri;
+                        } else {
+                            msg.payload.info.thumbnail_url = uploadedThumbnail.content_uri;
+                        }
+                    } catch (error) {
+                        node.error(`Error adding thumbnail: ${error.message}`, msg);
+                    }
+                }
+
+                async function createImageThumbnail(bufferOrPath) {
+                    try {
+                        if (Buffer.isBuffer(bufferOrPath)) {
+                            return sharp(bufferOrPath).resize({width: 320}).toBuffer();
+                        }
+                        return sharp(fs.readFileSync(bufferOrPath)).resize({width: 320}).toBuffer();
+                    } catch (error) {
+                        node.error(`Error creating image thumbnail: ${error.message}`);
+                        throw error;
+                    }
+                }
+
+                function _ffmpegVideoThumbnail(filepath) {
+                    return new Promise((resolve, reject) => {
+                        let filename = `${msg._msgid}-screenshot.png`;
+                        ffmpeg(filepath)
+                            .on('end', async function () {
+                                let path = `/tmp/${filename}`;
+                                let buffer = getFileBuffer(path, msg);
+                                let encryptedThumbnail = null;
+                                if (msg.encrypted) {
+                                    encryptedThumbnail = await encryptAttachment(buffer);
+                                    msg.payload.info.thumbnail_file = encryptedFile.info;
+                                }
+                                try {
+                                    await addThumbnail(encryptedThumbnail || buffer);
+                                    fs.rmSync(path); // delete temporary thumbnail file
+                                    resolve();
+                                } catch (e) {
+                                    return reject(new Error("Thumbnail upload failure: " + e));
+                                }
+                            })
+                            .on('error', function (err) {
+                                return reject(err);
+                            })
+                            .screenshots({
+                                timestamps: [0],
+                                filename: filename,
+                                folder: '/tmp',
+                                size: '320x?'
+                            });
+                    });
+                }
+
+                msg.payload = {};
+                if (msg.encrypted) {
+                    msg.payload.file = encryptedFile?.info || {};
+                    msg.payload.file.url = file.content_uri;
+                } else {
+                    msg.payload.url = file.content_uri;
+                }
+                msg.payload.msgtype = msgtype;
+                msg.payload.body = msg.body || msg.filename || "";
+                msg.payload.info = {
+                    "mimetype": contentType,
+                    "size": getFileSize(bufferOrPath),
+                };
+                if (msgtype === 'm.image') {
+                    // detect size of image
+                    try {
+                        let imageSize = getImageSize(bufferOrPath);
+                        msg.payload.info.h = imageSize.height;
+                        msg.payload.info.w = imageSize.width;
+
+                        // Generate thumbnail for image
+                        if (node.generateThumbnails) {
+                            let thumbnailBuffer = await createImageThumbnail(bufferOrPath);
+                            let encryptedThumbnail = null;
+                            if (msg.encrypted) {
+                                encryptedThumbnail = await encryptAttachment(thumbnailBuffer);
+                                msg.payload.info.thumbnail_file = encryptedThumbnail.info;
+                            }
+                            await addThumbnail(encryptedThumbnail || thumbnailBuffer);
+                        }
+                    } catch (e) {
+                        node.error("thumbnail error: " + e, msg);
+                    }
+                } else if (msgtype === 'm.audio' && detectedFileType) {
+                    try {
+                        // detect duration of audio clip
+                        let filepath = getFile(bufferOrPath);
+                        let metadata = await _ffprobe(filepath);
+                        let audioStream = metadata?.streams.filter(function (stream) {
+                            return stream.codec_type === "audio" || false;
+                        })[0];
+                        if (audioStream?.duration) {
+                            msg.payload.info.duration = audioStream?.duration * 1000;
+                        }
+                    } catch (e) {
+                        node.error(e, msg);
+                    }
+                    deleteTempFile();
+                } else if (msgtype === 'm.video' && detectedFileType) {
+                    let filepath = getFile(bufferOrPath);
+
+                    try {
+                        // detect duration & width/height of video clip
+                        let metadata = await _ffprobe(filepath);
+                        let videoStream = metadata?.streams.filter(function (stream) {
+                            return stream.codec_type === "video" || false;
+                        })[0];
+                        if (videoStream) {
+                            msg.payload.info.duration = videoStream.duration * 1000;
+                            msg.payload.info.w = videoStream.width;
+                            msg.payload.info.h = videoStream.height;
+                        }
+                    } catch (e) {
+                        node.error("ffprobe error: " + e, msg);
+                    }
+
+                    if (node.generateThumbnails) {
+                        try {
+                            await _ffmpegVideoThumbnail(filepath);
+                        } catch (e) {
+                            node.error("Screenshot generation error: " + e, msg);
+                        }
+                    }
+                    deleteTempFile();
+                }
+
+                node.send(msg, null);
+            } catch (error) {
+                node.error(`Unhandled error: ${error.message}`, msg);
+                node.log(error, msg);
+            }
         }
 
         node.on("close", function() {

src/matrix-user-settings.js

@@ -40,14 +40,6 @@ module.exports = function(RED) {
                 return;
             }
 
-            msg.topic = node.roomId || msg.topic;
-            if(!msg.topic) {
-                msg.error = "Room must be specified in msg.topic or in configuration";
-                node.error(msg.error, msg);
-                node.send([null, msg]);
-                return;
-            }
-
             let getterErrors = {},
                 setterErrors = {};
 

src/matrix-verification-action.html

@@ -0,0 +1,126 @@
+<script type="text/javascript">
+    RED.nodes.registerType('matrix-verification-action',{
+        category: 'matrix',
+        color: '#00b7ca',
+        icon: "matrix.png",
+        inputs: 1,
+        outputs: 2,
+        outputLabels: ["success", "error"],
+        align: 'right',
+        defaults: {
+            name: { value: null },
+            server: { type: "matrix-server-config" },
+            mode: { value: "accept" }
+        },
+        label: function() {
+            const labels = {
+                request: "Request verification",
+                accept: "Accept verification",
+                start: "Start SAS verification",
+                confirm: "Confirm SAS",
+                mismatch: "Reject SAS (mismatch)",
+                cancel: "Cancel verification"
+            };
+            return this.name || labels[this.mode] || "Verification Action";
+        },
+        paletteLabel: 'Verification Action'
+    });
+</script>
+
+<script type="text/html" data-template-name="matrix-verification-action">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-user"></i> Matrix Server Config</label>
+        <input type="text" id="node-input-server">
+    </div>
+    <div class="form-row">
+        <label for="node-input-mode"><i class="fa fa-shield"></i> Action</label>
+        <select id="node-input-mode">
+            <option value="request">Request verification</option>
+            <option value="accept">Accept verification</option>
+            <option value="start">Start SAS verification</option>
+            <option value="confirm">Confirm SAS</option>
+            <option value="mismatch">Reject SAS (mismatch)</option>
+            <option value="cancel">Cancel verification</option>
+        </select>
+    </div>
+    <div class="form-tips" style="margin-bottom: 12px;">
+        The action can also be overridden per message with <code>msg.mode</code>.
+    </div>
+</script>
+
+<script type="text/html" data-help-name="matrix-verification-action">
+    <h3>Details</h3>
+    <p>Acts on a Matrix device verification: request, accept, start, confirm or cancel it.</p>
+
+    <p>
+        This is the action counterpart to the <code>matrix-verification</code> node. The
+        <b>Action</b> set on the node decides what it does; it can also be overridden per
+        message with <code>msg.mode</code>. Every action except <b>Request verification</b>
+        operates on an existing verification identified by <code>msg.verificationId</code>
+        (as emitted by the <code>matrix-verification</code> node).
+    </p>
+    <p>
+        A typical SAS (emoji) flow: receive a <code>requested</code> event &rarr;
+        <b>Accept</b> &rarr; <b>Start SAS</b> &rarr; receive the <code>sas</code> event with
+        the emoji &rarr; have a human confirm &rarr; <b>Confirm SAS</b>.
+    </p>
+
+    <h3>Actions</h3>
+    <dl class="message-properties">
+        <dt>Request verification</dt>
+        <dd>Starts a new verification. With <code>msg.userId</code> + <code>msg.deviceId</code> it verifies a specific device; with <code>msg.userId</code> + <code>msg.topic</code> it verifies a user in that DM room; with neither it verifies the bot's own other devices.</dd>
+
+        <dt>Accept verification</dt>
+        <dd>Accepts an incoming verification request (moves it to the <code>ready</code> phase).</dd>
+
+        <dt>Start SAS verification</dt>
+        <dd>Begins SAS (emoji) verification. The emoji/decimal are delivered through the <code>matrix-verification</code> node as a <code>sas</code> phase event.</dd>
+
+        <dt>Confirm SAS</dt>
+        <dd>Confirms that the SAS emoji/decimal match. Call this once a human has verified the emoji.</dd>
+
+        <dt>Reject SAS (mismatch)</dt>
+        <dd>Declares that the SAS does not match, cancelling the verification.</dd>
+
+        <dt>Cancel verification</dt>
+        <dd>Cancels the verification request.</dd>
+    </dl>
+
+    <h3>Inputs</h3>
+    <dl class="message-properties">
+        <dt class="optional">msg.mode <span class="property-type">string</span></dt>
+        <dd>optional. Overrides the node's configured Action. One of <code>request</code>, <code>accept</code>, <code>start</code>, <code>confirm</code>, <code>mismatch</code>, <code>cancel</code>.</dd>
+
+        <dt>msg.verificationId <span class="property-type">string</span></dt>
+        <dd>required for every action except <code>request</code>. The id of the verification to act on, from the <code>matrix-verification</code> node.</dd>
+
+        <dt class="optional">msg.userId <span class="property-type">string</span></dt>
+        <dd>used by <code>request</code>: the user to verify.</dd>
+
+        <dt class="optional">msg.deviceId <span class="property-type">string</span></dt>
+        <dd>used by <code>request</code>: the specific device to verify (to-device verification).</dd>
+
+        <dt class="optional">msg.topic <span class="property-type">string</span></dt>
+        <dd>used by <code>request</code>: a DM room id, to verify a user in-room.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <ol class="node-ports">
+        <li>Success
+            <dl class="message-properties">
+                <dt>msg.verificationId <span class="property-type">string</span></dt>
+                <dd>the id of the verification that was acted on (or created, for <code>request</code>).</dd>
+            </dl>
+        </li>
+        <li>Error
+            <dl class="message-properties">
+                <dt>msg.error <span class="property-type">string</span></dt>
+                <dd>the error that occurred.</dd>
+            </dl>
+        </li>
+    </ol>
+</script>

src/matrix-verification-action.js

@@ -0,0 +1,139 @@
+module.exports = function(RED) {
+    function MatrixVerificationAction(n) {
+        RED.nodes.createNode(this, n);
+
+        let node = this;
+
+        this.name = n.name;
+        this.server = RED.nodes.getNode(n.server);
+        this.mode = n.mode || "accept";
+
+        node.status({ fill: "red", shape: "ring", text: "disconnected" });
+
+        if (!node.server) {
+            node.error("No configuration node");
+            return;
+        }
+        node.server.register(node);
+
+        node.server.on("disconnected", function() {
+            node.status({ fill: "red", shape: "ring", text: "disconnected" });
+        });
+        node.server.on("connected", function() {
+            node.status({ fill: "green", shape: "ring", text: "connected" });
+        });
+
+        node.on("input", async function(msg) {
+            if (!node.server || !node.server.matrixClient) {
+                msg.error = "No matrix server selected";
+                node.error(msg.error, msg);
+                node.send([null, msg]);
+                return;
+            }
+
+            if (!node.server.isConnected()) {
+                msg.error = "Matrix server connection is currently closed";
+                node.error(msg.error, msg);
+                node.send([null, msg]);
+                return;
+            }
+
+            const crypto = node.server.matrixClient.getCrypto();
+            if (!crypto) {
+                msg.error = "End-to-end encryption is not enabled on the Matrix server config";
+                node.error(msg.error, msg);
+                node.send([null, msg]);
+                return;
+            }
+
+            // msg.mode overrides the node's configured mode if provided
+            const mode = msg.mode || node.mode;
+
+            try {
+                if (mode === "request") {
+                    // Start a new verification request.
+                    //  - msg.userId + msg.deviceId : verify a specific device (to-device)
+                    //  - msg.userId + msg.topic    : verify a user in a DM room
+                    //  - otherwise                 : verify our own other devices
+                    let request;
+                    if (msg.userId && msg.deviceId) {
+                        request = await crypto.requestDeviceVerification(msg.userId, msg.deviceId);
+                    } else if (msg.userId && msg.topic) {
+                        request = await crypto.requestVerificationDM(msg.userId, msg.topic);
+                    } else {
+                        request = await crypto.requestOwnUserVerification();
+                    }
+
+                    if (typeof node.server.trackVerificationRequest === "function") {
+                        node.server.trackVerificationRequest(request);
+                    }
+                    msg.verificationId = request.transactionId;
+                    node.send([msg, null]);
+                    return;
+                }
+
+                // Every other mode acts on an existing tracked request.
+                const request = node.server.verificationRequests.get(msg.verificationId);
+                if (!request) {
+                    throw new Error(`No active verification found for msg.verificationId '${msg.verificationId}'`);
+                }
+
+                switch (mode) {
+                    case "accept":
+                        await request.accept();
+                        break;
+
+                    case "start": {
+                        // Begin SAS (emoji) verification. The SAS emoji is delivered
+                        // through the matrix-verification node when it becomes ready.
+                        let verifier = request.verifier;
+                        if (!verifier) {
+                            verifier = await request.startVerification("m.sas.v1");
+                        }
+                        verifier.verify().catch(function(e) {
+                            node.warn("Verification ended: " + e);
+                        });
+                        break;
+                    }
+
+                    case "confirm": {
+                        const sas = node.server.verificationSas.get(msg.verificationId);
+                        if (!sas) {
+                            throw new Error("This verification has no SAS awaiting confirmation");
+                        }
+                        await sas.confirm();
+                        break;
+                    }
+
+                    case "mismatch": {
+                        const sas = node.server.verificationSas.get(msg.verificationId);
+                        if (!sas) {
+                            throw new Error("This verification has no SAS awaiting confirmation");
+                        }
+                        sas.mismatch();
+                        break;
+                    }
+
+                    case "cancel":
+                        await request.cancel();
+                        break;
+
+                    default:
+                        throw new Error("Unknown verification action mode: " + mode);
+                }
+
+                msg.verificationId = request.transactionId;
+                node.send([msg, null]);
+            } catch (e) {
+                msg.error = String(e && e.message || e);
+                node.error("Verification action failed: " + msg.error, msg);
+                node.send([null, msg]);
+            }
+        });
+
+        node.on("close", function() {
+            node.server.deregister(node);
+        });
+    }
+    RED.nodes.registerType("matrix-verification-action", MatrixVerificationAction);
+}

src/matrix-verification.html

@@ -0,0 +1,199 @@
+<script type="text/javascript">
+    RED.nodes.registerType('matrix-verification',{
+        category: 'matrix',
+        color: '#00b7ca',
+        icon: "matrix.png",
+        inputs: 0,
+        outputs: 1,
+        defaults: {
+            name: { value: null },
+            server: { type: "matrix-server-config" },
+            phaseRequested: { value: true },
+            phaseReady: { value: true },
+            phaseStarted: { value: true },
+            phaseSas: { value: true },
+            phaseDone: { value: true },
+            phaseCancelled: { value: true },
+            initiatedBy: { value: "any" },
+            verificationType: { value: "any" },
+            selfVerification: { value: "any" },
+            userFilter: { value: "" },
+            roomFilter: { value: "" }
+        },
+        label: function() {
+            return this.name || "Verification";
+        },
+        paletteLabel: 'Verification'
+    });
+</script>
+
+<script type="text/html" data-template-name="matrix-verification">
+    <div class="form-row">
+        <label for="node-input-name"><i class="fa fa-tag"></i> Name</label>
+        <input type="text" id="node-input-name" placeholder="Name">
+    </div>
+    <div class="form-row">
+        <label for="node-input-server"><i class="fa fa-server"></i> Matrix Server</label>
+        <input type="text" id="node-input-server">
+    </div>
+
+    <div class="form-row" style="margin-left: 100px;margin-top:10px;font-weight:bold;">
+        Phase filter
+    </div>
+    <div class="form-tips" style="margin-bottom:6px;">Emit only the ticked phases.</div>
+    <div class="form-row" style="margin-bottom:0;">
+        <input type="checkbox" id="node-input-phaseRequested" style="width:auto;margin-left:125px;vertical-align:top" />
+        <label for="node-input-phaseRequested" style="width:auto">requested</label>
+    </div>
+    <div class="form-row" style="margin-bottom:0;">
+        <input type="checkbox" id="node-input-phaseReady" style="width:auto;margin-left:125px;vertical-align:top" />
+        <label for="node-input-phaseReady" style="width:auto">ready</label>
+    </div>
+    <div class="form-row" style="margin-bottom:0;">
+        <input type="checkbox" id="node-input-phaseStarted" style="width:auto;margin-left:125px;vertical-align:top" />
+        <label for="node-input-phaseStarted" style="width:auto">started</label>
+    </div>
+    <div class="form-row" style="margin-bottom:0;">
+        <input type="checkbox" id="node-input-phaseSas" style="width:auto;margin-left:125px;vertical-align:top" />
+        <label for="node-input-phaseSas" style="width:auto">sas (emoji ready to confirm)</label>
+    </div>
+    <div class="form-row" style="margin-bottom:0;">
+        <input type="checkbox" id="node-input-phaseDone" style="width:auto;margin-left:125px;vertical-align:top" />
+        <label for="node-input-phaseDone" style="width:auto">done</label>
+    </div>
+    <div class="form-row">
+        <input type="checkbox" id="node-input-phaseCancelled" style="width:auto;margin-left:125px;vertical-align:top" />
+        <label for="node-input-phaseCancelled" style="width:auto">cancelled</label>
+    </div>
+
+    <div class="form-row">
+        <label for="node-input-initiatedBy"><i class="fa fa-filter"></i> Initiated by</label>
+        <select id="node-input-initiatedBy">
+            <option value="any">Any</option>
+            <option value="me">Me (the bot started it)</option>
+            <option value="notme">Not me (the other party)</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-verificationType"><i class="fa fa-filter"></i> Type</label>
+        <select id="node-input-verificationType">
+            <option value="any">Any</option>
+            <option value="room">Room (in-room / DM)</option>
+            <option value="device">Device (to-device)</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-selfVerification"><i class="fa fa-filter"></i> Self-verify</label>
+        <select id="node-input-selfVerification">
+            <option value="any">Any</option>
+            <option value="self">Self only (bot's own devices)</option>
+            <option value="others">Others only (other users)</option>
+        </select>
+    </div>
+    <div class="form-row">
+        <label for="node-input-userFilter"><i class="fa fa-user"></i> User IDs</label>
+        <input type="text" id="node-input-userFilter" placeholder="@alice:example.org, @bob:example.org">
+    </div>
+    <div class="form-tips" style="margin-bottom:12px;">User ID allowlist - only emit verifications involving these users. Comma separated, or blank for any.</div>
+    <div class="form-row">
+        <label for="node-input-roomFilter"><i class="fa fa-comments"></i> Room IDs</label>
+        <input type="text" id="node-input-roomFilter" placeholder="!room:example.org, !other:example.org">
+    </div>
+    <div class="form-tips" style="margin-bottom:12px;">Restrict room verifications to these rooms. Comma separated, or blank for any. Device verifications are not affected.</div>
+</script>
+
+<script type="text/html" data-help-name="matrix-verification">
+    <h3>Details</h3>
+    <p>Emits a message when a device verification request is received or changes phase.</p>
+
+    <p>
+        This node is the event source for device verification. It outputs a message every
+        time a verification request is created (either incoming, or started with the
+        <code>matrix-verification-action</code> node) and again on every phase change. Use
+        it together with <code>matrix-verification-action</code> to build your own approval
+        flow &mdash; for example, emailing the SAS emoji to a human for confirmation.
+    </p>
+    <p>
+        Each message carries a <code>msg.verificationId</code> which is the handle you pass
+        to <code>matrix-verification-action</code> to act on that verification.
+    </p>
+
+    <h3>Filters</h3>
+    <p>
+        All filters are applied on the node so you don't need <code>switch</code> nodes
+        downstream. They AND-combine, and each defaults to passing everything.
+    </p>
+    <dl class="message-properties">
+        <dt>Phase filter</dt>
+        <dd>Emits only the ticked phases (<code>requested</code>, <code>ready</code>, <code>started</code>, <code>sas</code>, <code>done</code>, <code>cancelled</code>). All ticked = emit every phase.</dd>
+
+        <dt>Initiated by</dt>
+        <dd><code>Any</code>, <code>Me</code> (only verifications the bot started), or <code>Not me</code> (only verifications started by the other party).</dd>
+
+        <dt>Type</dt>
+        <dd><code>Any</code>, <code>Room</code> (in-room / DM verifications), or <code>Device</code> (to-device verifications).</dd>
+
+        <dt>Self-verify</dt>
+        <dd><code>Any</code>, <code>Self only</code> (the other party is another of the bot's own devices), or <code>Others only</code> (a different user).</dd>
+
+        <dt>User IDs</dt>
+        <dd>Allowlist of user IDs (comma separated). When set, only verifications involving one of these users are emitted. Blank = any user.</dd>
+
+        <dt>Room IDs</dt>
+        <dd>Comma separated room IDs. When set, room verifications are restricted to these rooms. Device verifications have no room and are not affected by this filter. Blank = any room.</dd>
+    </dl>
+
+    <h3>Outputs</h3>
+    <dl class="message-properties">
+        <dt>msg.verificationId <span class="property-type">string</span></dt>
+        <dd>unique id of the verification. Pass this as <code>msg.verificationId</code> to the <code>matrix-verification-action</code> node.</dd>
+
+        <dt>msg.phase <span class="property-type">string</span></dt>
+        <dd>
+            current phase of the verification, one of:
+            <code>requested</code> (a request was received/sent),
+            <code>ready</code> (the request was accepted),
+            <code>started</code> (a method was chosen),
+            <code>sas</code> (SAS emoji/decimal are ready to confirm &mdash; see <code>msg.sas</code>),
+            <code>done</code> (verification completed),
+            <code>cancelled</code> (verification cancelled).
+        </dd>
+
+        <dt>msg.payload <span class="property-type">string</span></dt>
+        <dd>same value as <code>msg.phase</code>, for convenience.</dd>
+
+        <dt>msg.userId <span class="property-type">string</span></dt>
+        <dd>the user id of the other party in the verification.</dd>
+
+        <dt>msg.deviceId <span class="property-type">string | null</span></dt>
+        <dd>the other party's device id, for to-device verifications. <code>null</code> for in-room verifications.</dd>
+
+        <dt>msg.topic <span class="property-type">string | null</span></dt>
+        <dd>the room id, for in-room (DM) verifications. <code>null</code> for to-device verifications.</dd>
+
+        <dt>msg.sas <span class="property-type">object</span></dt>
+        <dd>
+            present only when <code>msg.phase</code> is <code>sas</code>. Contains
+            <code>emoji</code> (an array of <code>[emoji, name]</code> pairs) and
+            <code>decimal</code> (an array of three numbers). One or both may be
+            populated depending on what was negotiated.
+        </dd>
+
+        <dt>msg.isSelfVerification <span class="property-type">boolean</span></dt>
+        <dd><code>true</code> if the other party is another device of the bot's own account.</dd>
+
+        <dt>msg.initiatedByMe <span class="property-type">boolean</span></dt>
+        <dd><code>true</code> if this verification was started by the bot.</dd>
+
+        <dt>msg.chosenMethod <span class="property-type">string | null</span></dt>
+        <dd>the verification method that was chosen (e.g. <code>m.sas.v1</code>), once one has been picked; <code>null</code> before then.</dd>
+
+        <dt>msg.cancellationCode <span class="property-type">string | null</span></dt>
+        <dd>present when <code>msg.phase</code> is <code>cancelled</code>; the reason code (e.g. <code>m.user</code>).</dd>
+    </dl>
+
+    <h3>References</h3>
+    <ul>
+        <li><a href="https://spec.matrix.org/latest/client-server-api/#device-verification">Matrix spec</a> - device verification</li>
+    </ul>
+</script>

src/matrix-verification.js

@@ -0,0 +1,113 @@
+module.exports = function(RED) {
+    function MatrixVerification(n) {
+        RED.nodes.createNode(this, n);
+
+        let node = this;
+
+        this.name = n.name;
+        this.server = RED.nodes.getNode(n.server);
+
+        // Phase filter - emit only the ticked phases. Undefined (config saved
+        // before these options existed) is treated as ticked, so old nodes
+        // keep emitting every phase.
+        this.phases = {
+            requested: n.phaseRequested !== false,
+            ready:     n.phaseReady     !== false,
+            started:   n.phaseStarted   !== false,
+            sas:       n.phaseSas       !== false,
+            done:      n.phaseDone      !== false,
+            cancelled: n.phaseCancelled !== false,
+        };
+        this.initiatedBy = n.initiatedBy || 'any';           // any | me | notme
+        this.verificationType = n.verificationType || 'any'; // any | room | device
+        this.selfVerification = n.selfVerification || 'any'; // any | self | others
+        this.userFilter = (n.userFilter || '').split(',')
+            .map(function(s){ return s.trim().toLowerCase(); })
+            .filter(Boolean);
+        this.roomFilter = (n.roomFilter || '').split(',')
+            .map(function(s){ return s.trim(); })
+            .filter(Boolean);
+
+        node.status({ fill: "red", shape: "ring", text: "disconnected" });
+
+        if (!node.server) {
+            node.error("No configuration node");
+            return;
+        }
+        node.server.register(node);
+
+        // Returns true if a verification update message passes every configured
+        // filter. All filters AND-combine; each defaults to "pass everything".
+        function passesFilters(m) {
+            // phase
+            if ((m.phase in node.phases) && !node.phases[m.phase]) {
+                return false;
+            }
+            // initiated by
+            if (node.initiatedBy === 'me' && !m.initiatedByMe) {
+                return false;
+            }
+            if (node.initiatedBy === 'notme' && m.initiatedByMe) {
+                return false;
+            }
+            // verification type - room verifications carry a roomId (msg.topic),
+            // to-device verifications do not
+            if (node.verificationType === 'room' && !m.topic) {
+                return false;
+            }
+            if (node.verificationType === 'device' && m.topic) {
+                return false;
+            }
+            // self-verification (the other party is one of the bot's own devices)
+            if (node.selfVerification === 'self' && !m.isSelfVerification) {
+                return false;
+            }
+            if (node.selfVerification === 'others' && m.isSelfVerification) {
+                return false;
+            }
+            // user id allowlist
+            if (node.userFilter.length &&
+                (!m.userId || node.userFilter.indexOf(m.userId.toLowerCase()) === -1)) {
+                return false;
+            }
+            // room id filter - only constrains room verifications; device
+            // verifications have no room and are not affected
+            if (node.roomFilter.length && m.topic &&
+                node.roomFilter.indexOf(m.topic) === -1) {
+                return false;
+            }
+            return true;
+        }
+
+        const onConnected = function() {
+            node.status({ fill: "green", shape: "ring", text: "connected" });
+        };
+        const onDisconnected = function() {
+            node.status({ fill: "red", shape: "ring", text: "disconnected" });
+        };
+        const onVerificationUpdate = function(verificationMsg) {
+            if (!passesFilters(verificationMsg)) {
+                return;
+            }
+            node.status({ fill: "blue", shape: "dot", text: verificationMsg.phase });
+            // clone so multiple verification nodes don't share/mutate one object
+            node.send(RED.util.cloneMessage(verificationMsg));
+        };
+
+        node.server.on("connected", onConnected);
+        node.server.on("disconnected", onDisconnected);
+        node.server.on("Verification.update", onVerificationUpdate);
+
+        if (node.server.isConnected && node.server.isConnected()) {
+            onConnected();
+        }
+
+        node.on("close", function() {
+            node.server.removeListener("connected", onConnected);
+            node.server.removeListener("disconnected", onDisconnected);
+            node.server.removeListener("Verification.update", onVerificationUpdate);
+            node.server.deregister(node);
+        });
+    }
+    RED.nodes.registerType("matrix-verification", MatrixVerification);
+}