devsyncwrld/backspace
1
0
Fork 0
Code Issues Pull Requests Actions 26 Packages Projects Releases Wiki Activity

docs: fix endpoint references and messageId format in relay docs

Browse Source
This commit is contained in:
Jannis Braun
2026-04-07 22:46:49 +02:00
parent 28624343d0
commit e3742e199a
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/systems/dm-system.md
+1 -1
View File
@@ -164,7 +164,7 @@ This ensures closed DMs resurface automatically when new activity occurs.
Close and reopen are relayed to all peer instances that hold a copy of the DM: Close and reopen are relayed to all peer instances that hold a copy of the DM:
- **Close relay:** After setting `closed = 1` locally, `queueDmCloseRelay(channelId, userId, 'dm_close')` queues a `dm_close` outbox event. The receiving instance finds the channel by `federatedId`, resolves the acting user via `resolveLocalUser`, sets `closed = 1` on the local `dm_members` row, and broadcasts `dm_channel_closed`. - **Close relay:** After setting `closed = 1` locally, `queueDmCloseRelay(channelId, userId, 'dm_close')` queues a `dm_close` outbox event. The receiving instance finds the channel by `federatedId`, resolves the acting user via `resolveLocalUser`, sets `closed = 1` on the local `dm_members` row, and broadcasts `dm_channel_closed`.
- **Reopen relay:** Explicit reopens (`POST /api/dm/:id/reopen`) queue a `dm_reopen` event. The receiving instance sets `closed = 0` and broadcasts `dm_channel_created` with a full channel payload. - **Reopen relay:** Explicit reopens (`POST /api/dm` when reopening a closed 1-on-1 DM) queue a `dm_reopen` event. The receiving instance sets `closed = 0` and broadcasts `dm_channel_created` with a full channel payload.
- **Relayed-message reopen:** `processCreateEvent` (inbound message relay) also checks each recipient's `closed` flag and performs the same resurface sequence (`dm_channel_created` → `dm_message_created`) — mirroring `broadcastDmMessage`. This ensures messages relayed from a remote instance properly reopen closed DMs on the receiving instance. - **Relayed-message reopen:** `processCreateEvent` (inbound message relay) also checks each recipient's `closed` flag and performs the same resurface sequence (`dm_channel_created` → `dm_message_created`) — mirroring `broadcastDmMessage`. This ensures messages relayed from a remote instance properly reopen closed DMs on the receiving instance.
- Only fires for DMs with a `federatedId`. Legacy local-only DMs (no `federatedId`) are unaffected. - Only fires for DMs with a `federatedId`. Legacy local-only DMs (no `federatedId`) are unaffected.
docs/systems/federation.md
+2 -2
View File
@@ -688,7 +688,7 @@ Only DMs with a `federatedId` are eligible. Legacy local-only DMs (created befor
| Event | Trigger | | Event | Trigger |
|-------|---------| |-------|---------|
| `dm_close` | User calls `DELETE /api/dm/:id` (soft-close) | | `dm_close` | User calls `DELETE /api/dm/:id` (soft-close) |
| `dm_reopen` | User calls `POST /api/dm/:id/reopen` (explicit reopen) | | `dm_reopen` | User calls `POST /api/dm` and reopens a closed 1-on-1 DM |
### Payload ### Payload
@@ -697,7 +697,7 @@ Only DMs with a `federatedId` are eligible. Legacy local-only DMs (created befor
eventType: 'dm_close' | 'dm_reopen', eventType: 'dm_close' | 'dm_reopen',
dmChannelId: string, // local channel ID (context only) dmChannelId: string, // local channel ID (context only)
federatedId: string, // cross-instance channel lookup key federatedId: string, // cross-instance channel lookup key
messageId: string, // unique event ID: 'dm_close:{userId}:{ts}' or 'dm_reopen:{userId}:{ts}' messageId: string, // unique event ID: 'dm_close:{federatedId}:{userId}:{ts}'
encryptionVersion: 0, encryptionVersion: 0,
timestamp: number, timestamp: number,
dmCloseReopen: { dmCloseReopen: {