From 96057638ce7e7bbde97fec6373d703b5ebe1dff9 Mon Sep 17 00:00:00 2001
From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com>
Date: Mon, 10 Jun 2024 13:17:27 +0100
Subject: [PATCH] Spec `unsigned.membership` property, per MSC4115 (#1847)

---
 .../client_server/newsfragments/1847.feature  |  1 +
 .../client_event_without_room_id.yaml         | 21 +++++++++++++++++++
 .../examples/core/room_event.json             |  3 ++-
 3 files changed, 24 insertions(+), 1 deletion(-)
 create mode 100644 changelogs/client_server/newsfragments/1847.feature

diff --git a/changelogs/client_server/newsfragments/1847.feature b/changelogs/client_server/newsfragments/1847.feature
new file mode 100644
index 000000000..25d1914b9
--- /dev/null
+++ b/changelogs/client_server/newsfragments/1847.feature
@@ -0,0 +1 @@
+Add the new `unsigned.membership` property to events served over the client-server API, as per [MSC4115](https://github.com/matrix-org/matrix-spec-proposals/pull/4115).
diff --git a/data/api/client-server/definitions/client_event_without_room_id.yaml b/data/api/client-server/definitions/client_event_without_room_id.yaml
index d78dcc684..b12611a21 100644
--- a/data/api/client-server/definitions/client_event_without_room_id.yaml
+++ b/data/api/client-server/definitions/client_event_without_room_id.yaml
@@ -90,6 +90,7 @@ properties:
           "origin_server_ts": 1632491098485,
           "unsigned": {
             "age": 1257,
+            "membership": "leave"
           }
         }
       transaction_id:
@@ -112,3 +113,23 @@ properties:
             this.
         title: EventContent
         type: object
+      membership:
+        description: |
+          The room membership of the user making the request, at the time of the event.
+
+          This property is the value of the `membership` property of the
+          requesting user's [`m.room.member`](/client-server-api#mroommember)
+          state at the point of the event, including any changes caused by the
+          event. If the user had yet to join the room at the time of the event
+          (i.e, they have no `m.room.member` state), this property is set to
+          `leave`.
+
+          Homeservers SHOULD populate this property
+          wherever practical, but they MAY omit it if necessary (for example,
+          if calculating the value is expensive, servers might choose to only
+          implement it in encrypted rooms). The property is *not* normally populated
+          in events pushed to application services via the application service transaction API
+          (where there is no clear definition of "requesting user").
+        type: string
+        example: join
+        x-addedInMatrixVersion: "1.11"
diff --git a/data/event-schemas/examples/core/room_event.json b/data/event-schemas/examples/core/room_event.json
index 521225cc0..9bd62e283 100644
--- a/data/event-schemas/examples/core/room_event.json
+++ b/data/event-schemas/examples/core/room_event.json
@@ -5,6 +5,7 @@
     "sender": "@example:example.org",
     "origin_server_ts": 1432735824653,
     "unsigned": {
-      "age": 1234
+      "age": 1234,
+      "membership": "join"
     }
 }