Add Telegram-style delivery receipt to Paarrot.
Trigger cinny-mobile / dispatch (push) Successful in 1s

Matrix has no delivery receipt type in the spec (Synapse only accepts
m.read, m.read.private and m.fully_read), so delivery is recorded as a
client-defined event com.paarrot.received related to the target message
with m.reference. The app sends the marker when a notification fires for
a message, and the bottom-right indicator shows a single tick when
received-but-not-read and the existing double tick once read. Other
clients see an unknown event; cinny never renders it in the timeline
because events with a relation are skipped unless show hidden events is on.
This commit is contained in:
2026-10-13 08:01:04 +11:00
parent bd649d4e16
commit 76e5f960d1
4 changed files with 117 additions and 8 deletions
+53
View File
@@ -0,0 +1,53 @@
import { MatrixClient, RelationType, Room } from 'matrix-js-sdk';
/**
* Client-defined event marking that Paarrot has received a message.
*
* The spec has no delivery receipt type - Synapse only accepts `m.read`,
* `m.read.private` and `m.fully_read` on the receipts endpoint - so delivery is
* recorded as a custom event related to the target message with `m.reference`.
*
* It never shows in the cinny timeline (events with a relation are skipped
* unless "show hidden events" is on), and other clients only see an unknown
* event. Delivery is always self-reported: in E2EE, only the receiving client
* can know it actually got the event.
*/
export const PAARROT_RECEIVED_EVENT = 'com.paarrot.received';
export const getReceivedContent = (eventId: string) => ({
'm.relates_to': {
event_id: eventId,
rel_type: RelationType.Reference,
},
});
export const getEventDeliveryRelations = (room: Room, eventId: string) =>
room
.getUnfilteredTimelineSet()
.relations.getChildEventsForEvent(eventId, RelationType.Reference, PAARROT_RECEIVED_EVENT);
export const hasReceivedMarker = (room: Room, eventId: string, userId: string): boolean => {
const relations = getEventDeliveryRelations(room, eventId);
if (!relations) return false;
return relations
.getRelations()
.some(
(rel) =>
!rel.isRedacted() && rel.getSender() === userId && rel.getRelation()?.event_id === eventId,
);
};
/**
* Sends the delivery marker for `eventId`. Skips events that are still local
* echoes (no `$` id yet) and events this user already marked, so a room that
* re-syncs does not spam markers.
*/
export async function sendReceivedMarker(mx: MatrixClient, room: Room, eventId: string) {
const userId = mx.getUserId();
if (!userId || !eventId.startsWith('$')) return false;
if (hasReceivedMarker(room, eventId, userId)) return false;
await mx.sendEvent(room.roomId, PAARROT_RECEIVED_EVENT, getReceivedContent(eventId));
return true;
}