@textrp/briij-js-sdk 41.0.0 → 42.0.0

package/src/@types/event.ts

@@ -1,449 +1,476 @@
-/*
-Copyright 2020-2026 The Matrix.org Foundation C.I.C.
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-import { type EitherAnd } from "matrix-events-sdk";
-
-import { NamespacedValue, UnstableValue } from "../NamespacedValue.ts";
-import {
-    type PolicyRuleEventContent,
-    type RoomAvatarEventContent,
-    type RoomCanonicalAliasEventContent,
-    type RoomCreateEventContent,
-    type RoomEncryptionEventContent,
-    type RoomGuestAccessEventContent,
-    type RoomHistoryVisibilityEventContent,
-    type RoomJoinRulesEventContent,
-    type RoomMemberEventContent,
-    type RoomNameEventContent,
-    type RoomPinnedEventsEventContent,
-    type RoomPolicyContent,
-    type RoomPowerLevelsEventContent,
-    type RoomServerAclEventContent,
-    type RoomThirdPartyInviteEventContent,
-    type RoomTombstoneEventContent,
-    type RoomTopicEventContent,
-    type SpaceChildEventContent,
-    type SpaceParentEventContent,
-} from "./state_events.ts";
-import { type IGroupCallRoomMemberState, type IGroupCallRoomState } from "../webrtc/groupCall.ts";
-import { type MSC3089EventContent } from "../models/MSC3089Branch.ts";
-import { type M_BEACON, type M_BEACON_INFO, type MBeaconEventContent, type MBeaconInfoEventContent } from "./beacon.ts";
-import { type EmptyObject } from "./common.ts";
-import { type ReactionEventContent, type RoomMessageEventContent, type StickerEventContent } from "./events.ts";
-import {
-    type MCallAnswer,
-    type MCallBase,
-    type MCallCandidates,
-    type MCallHangupReject,
-    type MCallInviteNegotiate,
-    type MCallReplacesEvent,
-    type MCallSelectAnswer,
-    type SDPStreamMetadata,
-} from "../webrtc/callEventTypes.ts";
-import {
-    type IRTCNotificationContent,
-    type IRTCDeclineContent,
-    type EncryptionKeysEventContent,
-    type ICallNotifyContent,
-} from "../matrixrtc/types.ts";
-import { type M_POLL_END, type M_POLL_START, type PollEndEventContent, type PollStartEventContent } from "./polls.ts";
-import { type RtcMembershipData, type SessionMembershipData } from "../matrixrtc/membershipData/index.ts";
-import { type LocalNotificationSettings } from "./local_notifications.ts";
-import { type IPushRules } from "./PushRules.ts";
-import { type SecretInfo, type SecretStorageKeyDescription } from "../secret-storage.ts";
-import { type POLICIES_ACCOUNT_EVENT_TYPE } from "../models/invites-ignorer-types.ts";
-
-export enum EventType {
-    // Room state events
-    RoomCanonicalAlias = "m.room.canonical_alias",
-    RoomCreate = "m.room.create",
-    RoomJoinRules = "m.room.join_rules",
-    RoomMember = "m.room.member",
-    RoomThirdPartyInvite = "m.room.third_party_invite",
-    RoomPowerLevels = "m.room.power_levels",
-    RoomName = "m.room.name",
-    RoomTopic = "m.room.topic",
-    RoomAvatar = "m.room.avatar",
-    RoomPinnedEvents = "m.room.pinned_events",
-    RoomEncryption = "m.room.encryption",
-    RoomHistoryVisibility = "m.room.history_visibility",
-    RoomGuestAccess = "m.room.guest_access",
-    RoomServerAcl = "m.room.server_acl",
-    RoomTombstone = "m.room.tombstone",
-    RoomPredecessor = "org.matrix.msc3946.room_predecessor",
-
-    // Moderation policy lists
-    PolicyRuleUser = "m.policy.rule.user",
-    PolicyRuleRoom = "m.policy.rule.room",
-    PolicyRuleServer = "m.policy.rule.server",
-
-    SpaceChild = "m.space.child",
-    SpaceParent = "m.space.parent",
-
-    // Room timeline events
-    RoomRedaction = "m.room.redaction",
-    RoomMessage = "m.room.message",
-    RoomMessageEncrypted = "m.room.encrypted",
-    Sticker = "m.sticker",
-    CallInvite = "m.call.invite",
-    CallCandidates = "m.call.candidates",
-    CallAnswer = "m.call.answer",
-    CallHangup = "m.call.hangup",
-    CallReject = "m.call.reject",
-    CallSelectAnswer = "m.call.select_answer",
-    CallNegotiate = "m.call.negotiate",
-    CallSDPStreamMetadataChanged = "m.call.sdp_stream_metadata_changed",
-    CallSDPStreamMetadataChangedPrefix = "org.matrix.call.sdp_stream_metadata_changed",
-    CallReplaces = "m.call.replaces",
-    CallAssertedIdentity = "m.call.asserted_identity",
-    CallAssertedIdentityPrefix = "org.matrix.call.asserted_identity",
-    CallEncryptionKeysPrefix = "io.element.call.encryption_keys",
-    KeyVerificationRequest = "m.key.verification.request",
-    KeyVerificationStart = "m.key.verification.start",
-    KeyVerificationCancel = "m.key.verification.cancel",
-    KeyVerificationMac = "m.key.verification.mac",
-    KeyVerificationDone = "m.key.verification.done",
-    KeyVerificationKey = "m.key.verification.key",
-    KeyVerificationAccept = "m.key.verification.accept",
-    // Not used directly - see READY_TYPE in VerificationRequest.
-    KeyVerificationReady = "m.key.verification.ready",
-    // use of this is discouraged https://matrix.org/docs/spec/client_server/r0.6.1#m-room-message-feedback
-    RoomMessageFeedback = "m.room.message.feedback",
-    Reaction = "m.reaction",
-    PollStart = "org.matrix.msc3381.poll.start",
-
-    // Room ephemeral events
-    Typing = "m.typing",
-    Receipt = "m.receipt",
-    Presence = "m.presence",
-
-    // Room account_data events
-    FullyRead = "m.fully_read",
-    Tag = "m.tag",
-    SpaceOrder = "org.matrix.msc3230.space_order", // MSC3230
-    MarkedUnread = "m.marked_unread",
-
-    // User account_data events
-    PushRules = "m.push_rules",
-    Direct = "m.direct",
-    IgnoredUserList = "m.ignored_user_list",
-    InvitePermissionConfig = "m.invite_permission_config", // MSC4380
-
-    // to_device events
-    RoomKey = "m.room_key",
-    RoomKeyRequest = "m.room_key_request",
-    ForwardedRoomKey = "m.forwarded_room_key",
-    Dummy = "m.dummy",
-    SecretRequest = "m.secret.request",
-    SecretSend = "m.secret.send",
-
-    // Group call events
-    GroupCallPrefix = "org.matrix.msc3401.call",
-    GroupCallMemberPrefix = "org.matrix.msc3401.call.member",
-
-    // MatrixRTC events
-    RTCMembership = "org.matrix.msc4143.rtc.member",
-    CallNotify = "org.matrix.msc4075.call.notify",
-    RTCNotification = "org.matrix.msc4075.rtc.notification",
-    RTCDecline = "org.matrix.msc4310.rtc.decline",
-
-    // Policy servers
-    RoomPolicy = "org.matrix.msc4284.policy",
-}
-
-export enum RelationType {
-    Annotation = "m.annotation",
-    Replace = "m.replace",
-    Reference = "m.reference",
-
-    // Don't use this yet: it's only the stable version. The code still assumes we support the unstable prefix and,
-    // moreover, our tests currently use the unstable prefix. Use THREAD_RELATION_TYPE.name.
-    // Once we support *only* the stable prefix, THREAD_RELATION_TYPE can die and we can switch to this.
-    Thread = "m.thread",
-}
-
-export enum MsgType {
-    Text = "m.text",
-    Emote = "m.emote",
-    Notice = "m.notice",
-    Image = "m.image",
-    File = "m.file",
-    Audio = "m.audio",
-    Location = "m.location",
-    Video = "m.video",
-    KeyVerificationRequest = "m.key.verification.request",
-}
-
-export const RoomCreateTypeField = "type";
-
-export enum RoomType {
-    Space = "m.space",
-    UnstableCall = "org.matrix.msc3417.call",
-    ElementVideo = "io.element.video",
-}
-
-export const ToDeviceMessageId = "org.matrix.msgid";
-
-/**
- * Identifier for an [MSC3088](https://github.com/matrix-org/matrix-doc/pull/3088)
- * room purpose. Note that this reference is UNSTABLE and subject to breaking changes,
- * including its eventual removal.
- */
-export const UNSTABLE_MSC3088_PURPOSE = new UnstableValue("m.room.purpose", "org.matrix.msc3088.purpose");
-
-/**
- * Enabled flag for an [MSC3088](https://github.com/matrix-org/matrix-doc/pull/3088)
- * room purpose. Note that this reference is UNSTABLE and subject to breaking changes,
- * including its eventual removal.
- */
-export const UNSTABLE_MSC3088_ENABLED = new UnstableValue("m.enabled", "org.matrix.msc3088.enabled");
-
-/**
- * Subtype for an [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) space-room.
- * Note that this reference is UNSTABLE and subject to breaking changes, including its
- * eventual removal.
- */
-export const UNSTABLE_MSC3089_TREE_SUBTYPE = new UnstableValue("m.data_tree", "org.matrix.msc3089.data_tree");
-
-/**
- * Leaf type for an event in a [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) space-room.
- * Note that this reference is UNSTABLE and subject to breaking changes, including its
- * eventual removal.
- */
-export const UNSTABLE_MSC3089_LEAF = new UnstableValue("m.leaf", "org.matrix.msc3089.leaf");
-
-/**
- * Branch (Leaf Reference) type for the index approach in a
- * [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) space-room. Note that this reference is
- * UNSTABLE and subject to breaking changes, including its eventual removal.
- */
-export const UNSTABLE_MSC3089_BRANCH = new UnstableValue("m.branch", "org.matrix.msc3089.branch");
-
-/**
- * Marker event type to point back at imported historical content in a room. See
- * [MSC2716](https://github.com/matrix-org/matrix-spec-proposals/pull/2716).
- * Note that this reference is UNSTABLE and subject to breaking changes,
- * including its eventual removal.
- */
-export const UNSTABLE_MSC2716_MARKER = new UnstableValue("m.room.marker", "org.matrix.msc2716.marker");
-
-/**
- * Name of the request property for relation based redactions.
- * {@link https://github.com/matrix-org/matrix-spec-proposals/pull/3912}
- */
-export const MSC3912_RELATION_BASED_REDACTIONS_PROP = new UnstableValue(
-    "with_rel_types",
-    "org.matrix.msc3912.with_relations",
-);
-
-/**
- * Functional members type for declaring a purpose of room members (e.g. helpful bots).
- * Note that this reference is UNSTABLE and subject to breaking changes, including its
- * eventual removal.
- *
- * Schema (TypeScript):
- * ```
- * {
- *   service_members?: string[]
- * }
- * ```
- *
- * @example
- * ```
- * {
- *   "service_members": [
- *     "@helperbot:localhost",
- *     "@reminderbot:alice.tdl"
- *   ]
- * }
- * ```
- */
-export const UNSTABLE_ELEMENT_FUNCTIONAL_USERS = new UnstableValue(
-    "io.element.functional_members",
-    "io.element.functional_members",
-);
-
-/**
- * A type of message that affects visibility of a message,
- * as per https://github.com/matrix-org/matrix-doc/pull/3531
- *
- * @experimental
- */
-export const EVENT_VISIBILITY_CHANGE_TYPE = new UnstableValue("m.visibility", "org.matrix.msc3531.visibility");
-
-/**
- * https://github.com/matrix-org/matrix-doc/pull/3881
- *
- * @experimental
- */
-export const PUSHER_ENABLED = new UnstableValue("enabled", "org.matrix.msc3881.enabled");
-
-/**
- * https://github.com/matrix-org/matrix-doc/pull/3881
- *
- * @experimental
- */
-export const PUSHER_DEVICE_ID = new UnstableValue("device_id", "org.matrix.msc3881.device_id");
-
-/**
- * https://github.com/matrix-org/matrix-doc/pull/3890
- *
- * @experimental
- */
-export const LOCAL_NOTIFICATION_SETTINGS_PREFIX = new UnstableValue(
-    "m.local_notification_settings",
-    "org.matrix.msc3890.local_notification_settings",
-);
-
-/**
- * https://github.com/matrix-org/matrix-doc/pull/4023
- *
- * @experimental
- */
-export const UNSIGNED_THREAD_ID_FIELD = new UnstableValue("thread_id", "org.matrix.msc4023.thread_id");
-
-/**
- * https://github.com/matrix-org/matrix-spec-proposals/pull/4115
- *
- * @experimental
- */
-export const UNSIGNED_MEMBERSHIP_FIELD = new NamespacedValue("membership", "io.element.msc4115.membership");
-
-/**
- * Mapped type from event type to content type for all specified non-state room events.
- */
-export interface TimelineEvents {
-    [EventType.RoomMessage]: RoomMessageEventContent;
-    [EventType.Sticker]: StickerEventContent;
-    [EventType.Reaction]: ReactionEventContent;
-    [EventType.CallReplaces]: MCallReplacesEvent;
-    [EventType.CallAnswer]: MCallAnswer;
-    [EventType.CallSelectAnswer]: MCallSelectAnswer;
-    [EventType.CallNegotiate]: Omit<MCallInviteNegotiate, "offer">;
-    [EventType.CallInvite]: MCallInviteNegotiate;
-    [EventType.CallCandidates]: MCallCandidates;
-    [EventType.CallHangup]: MCallHangupReject;
-    [EventType.CallReject]: MCallHangupReject;
-    [EventType.CallSDPStreamMetadataChangedPrefix]: MCallBase &
-        EitherAnd<
-            { sdp_stream_metadata: SDPStreamMetadata },
-            { "org.matrix.msc3077.sdp_stream_metadata": SDPStreamMetadata }
-        >;
-    [EventType.CallSDPStreamMetadataChanged]: MCallBase &
-        EitherAnd<
-            { sdp_stream_metadata: SDPStreamMetadata },
-            { "org.matrix.msc3077.sdp_stream_metadata": SDPStreamMetadata }
-        >;
-    [EventType.CallEncryptionKeysPrefix]: EncryptionKeysEventContent;
-    [EventType.CallNotify]: ICallNotifyContent;
-    [EventType.RTCNotification]: IRTCNotificationContent;
-    [EventType.RTCDecline]: IRTCDeclineContent;
-    [M_BEACON.name]: MBeaconEventContent;
-    [M_POLL_START.name]: PollStartEventContent;
-    [M_POLL_END.name]: PollEndEventContent;
-    [EventType.RTCMembership]: RtcMembershipData | { msc4354_sticky_key: string }; // An object containing just the sticky key is empty.
-}
-
-/**
- * Mapped type from event type to content type for all specified room state events.
- */
-export interface StateEvents {
-    [EventType.RoomCanonicalAlias]: RoomCanonicalAliasEventContent;
-    [EventType.RoomCreate]: RoomCreateEventContent;
-    [EventType.RoomJoinRules]: RoomJoinRulesEventContent;
-    [EventType.RoomMember]: RoomMemberEventContent;
-    // XXX: Spec says this event has 3 required fields but kicking such an invitation requires sending `{}`
-    [EventType.RoomThirdPartyInvite]: RoomThirdPartyInviteEventContent | EmptyObject;
-    [EventType.RoomPowerLevels]: RoomPowerLevelsEventContent;
-    [EventType.RoomName]: RoomNameEventContent;
-    [EventType.RoomTopic]: RoomTopicEventContent;
-    [EventType.RoomAvatar]: RoomAvatarEventContent;
-    [EventType.RoomPinnedEvents]: RoomPinnedEventsEventContent;
-    [EventType.RoomEncryption]: RoomEncryptionEventContent;
-    [EventType.RoomHistoryVisibility]: RoomHistoryVisibilityEventContent;
-    [EventType.RoomGuestAccess]: RoomGuestAccessEventContent;
-    [EventType.RoomServerAcl]: RoomServerAclEventContent;
-    [EventType.RoomTombstone]: RoomTombstoneEventContent;
-    [EventType.SpaceChild]: SpaceChildEventContent;
-    [EventType.SpaceParent]: SpaceParentEventContent;
-
-    [EventType.PolicyRuleUser]: PolicyRuleEventContent | EmptyObject;
-    [EventType.PolicyRuleRoom]: PolicyRuleEventContent | EmptyObject;
-    [EventType.PolicyRuleServer]: PolicyRuleEventContent | EmptyObject;
-
-    // MSC4284: Policy servers
-    [EventType.RoomPolicy]: RoomPolicyContent | EmptyObject;
-
-    // MSC3401
-    [EventType.GroupCallPrefix]: IGroupCallRoomState;
-    [EventType.GroupCallMemberPrefix]: IGroupCallRoomMemberState | SessionMembershipData | EmptyObject;
-    [EventType.RTCMembership]: RtcMembershipData | EmptyObject;
-    // MSC3089
-    [UNSTABLE_MSC3089_BRANCH.name]: MSC3089EventContent;
-
-    // MSC3672
-    [M_BEACON_INFO.name]: MBeaconInfoEventContent;
-}
-
-/**
- * Mapped type from event type to content type for all specified room-specific account_data events.
- */
-export interface RoomAccountDataEvents extends SecretStorageAccountDataEvents {
-    [EventType.FullyRead]: { event_id: string };
-    [EventType.Tag]: { tags: { [name: string]: { order?: number } } };
-    [EventType.SpaceOrder]: { order: string };
-    [EventType.MarkedUnread]: { unread: boolean };
-}
-
-/**
- * Mapped type from event type to content type for all specified global account_data events.
- */
-export interface AccountDataEvents extends SecretStorageAccountDataEvents {
-    [EventType.PushRules]: IPushRules;
-    [EventType.Direct]: { [userId: string]: string[] };
-    [EventType.IgnoredUserList]: { ignored_users: { [userId: string]: EmptyObject } };
-    "m.secret_storage.default_key": { key: string };
-    // Flag set by the rust SDK (Element X) and also used by us to mark that the user opted out of backup
-    // (I don't know why it's m.org.matrix...)
-    "m.org.matrix.custom.backup_disabled": { disabled: boolean };
-    "m.identity_server": { base_url: string | null };
-    [key: `${typeof LOCAL_NOTIFICATION_SETTINGS_PREFIX.name}.${string}`]: LocalNotificationSettings;
-    [key: `m.secret_storage.key.${string}`]: SecretStorageKeyDescription;
-
-    // Invites-ignorer events
-    [POLICIES_ACCOUNT_EVENT_TYPE.name]: { [key: string]: any };
-    [POLICIES_ACCOUNT_EVENT_TYPE.altName]: { [key: string]: any };
-
-    [EventType.InvitePermissionConfig]: { default_action?: string };
-}
-
-/**
- * Subset of AccountDataEvents, excluding events specified in https://spec.matrix.org/v1.17/client-server-api/#server-behaviour-12
- */
-export type WritableAccountDataEvents = Exclude<AccountDataEvents, "m.fully_read" | "m.push_rules">;
-
-/**
- * Mapped type from event type to content type for all specified global events encrypted by secret storage.
- *
- * See https://spec.matrix.org/v1.13/client-server-api/#msecret_storagev1aes-hmac-sha2-1
- */
-export interface SecretStorageAccountDataEvents {
-    "m.megolm_backup.v1": SecretInfo;
-    "m.cross_signing.master": SecretInfo;
-    "m.cross_signing.self_signing": SecretInfo;
-    "m.cross_signing.user_signing": SecretInfo;
-    "org.matrix.msc3814": SecretInfo;
-}
+/*
+Copyright 2020-2026 The Matrix.org Foundation C.I.C.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+import { type EitherAnd } from "matrix-events-sdk";
+
+import { NamespacedValue, UnstableValue } from "../NamespacedValue.ts";
+import {
+    type PolicyRuleEventContent,
+    type RoomAvatarEventContent,
+    type RoomCanonicalAliasEventContent,
+    type RoomCreateEventContent,
+    type RoomEncryptionEventContent,
+    type RoomGuestAccessEventContent,
+    type RoomHistoryVisibilityEventContent,
+    type RoomJoinRulesEventContent,
+    type RoomMemberEventContent,
+    type RoomNameEventContent,
+    type RoomPinnedEventsEventContent,
+    type RoomPolicyContent,
+    type RoomPowerLevelsEventContent,
+    type RoomServerAclEventContent,
+    type RoomThirdPartyInviteEventContent,
+    type RoomTombstoneEventContent,
+    type RoomTopicEventContent,
+    type SpaceChildEventContent,
+    type SpaceParentEventContent,
+} from "./state_events.ts";
+import { type IGroupCallRoomMemberState, type IGroupCallRoomState } from "../webrtc/groupCall.ts";
+import { type MSC3089EventContent } from "../models/MSC3089Branch.ts";
+import { type M_BEACON, type M_BEACON_INFO, type MBeaconEventContent, type MBeaconInfoEventContent } from "./beacon.ts";
+import { type EmptyObject } from "./common.ts";
+import { type ReactionEventContent, type RoomMessageEventContent, type StickerEventContent } from "./events.ts";
+import {
+    type MCallAnswer,
+    type MCallBase,
+    type MCallCandidates,
+    type MCallHangupReject,
+    type MCallInviteNegotiate,
+    type MCallReplacesEvent,
+    type MCallSelectAnswer,
+    type SDPStreamMetadata,
+} from "../webrtc/callEventTypes.ts";
+import {
+    type IRTCNotificationContent,
+    type IRTCDeclineContent,
+    type EncryptionKeysEventContent,
+    type ICallNotifyContent,
+} from "../matrixrtc/types.ts";
+import { type M_POLL_END, type M_POLL_START, type PollEndEventContent, type PollStartEventContent } from "./polls.ts";
+import { type RtcMembershipData, type SessionMembershipData } from "../matrixrtc/membershipData/index.ts";
+import { type LocalNotificationSettings } from "./local_notifications.ts";
+import { type IPushRules } from "./PushRules.ts";
+import { type SecretInfo, type SecretStorageKeyDescription } from "../secret-storage.ts";
+import { type POLICIES_ACCOUNT_EVENT_TYPE } from "../models/invites-ignorer-types.ts";
+
+export enum EventType {
+    // Room state events
+    RoomCanonicalAlias = "m.room.canonical_alias",
+    RoomCreate = "m.room.create",
+    RoomJoinRules = "m.room.join_rules",
+    RoomMember = "m.room.member",
+    RoomThirdPartyInvite = "m.room.third_party_invite",
+    RoomPowerLevels = "m.room.power_levels",
+    RoomName = "m.room.name",
+    RoomTopic = "m.room.topic",
+    RoomAvatar = "m.room.avatar",
+    RoomPinnedEvents = "m.room.pinned_events",
+    RoomEncryption = "m.room.encryption",
+    RoomHistoryVisibility = "m.room.history_visibility",
+    RoomGuestAccess = "m.room.guest_access",
+    RoomServerAcl = "m.room.server_acl",
+    RoomTombstone = "m.room.tombstone",
+    RoomPredecessor = "org.matrix.msc3946.room_predecessor",
+
+    // Moderation policy lists
+    PolicyRuleUser = "m.policy.rule.user",
+    PolicyRuleRoom = "m.policy.rule.room",
+    PolicyRuleServer = "m.policy.rule.server",
+
+    SpaceChild = "m.space.child",
+    SpaceParent = "m.space.parent",
+
+    // Room timeline events
+    RoomRedaction = "m.room.redaction",
+    RoomMessage = "m.room.message",
+    RoomMessageEncrypted = "m.room.encrypted",
+    Sticker = "m.sticker",
+    CallInvite = "m.call.invite",
+    CallCandidates = "m.call.candidates",
+    CallAnswer = "m.call.answer",
+    CallHangup = "m.call.hangup",
+    CallReject = "m.call.reject",
+    CallSelectAnswer = "m.call.select_answer",
+    CallNegotiate = "m.call.negotiate",
+    CallSDPStreamMetadataChanged = "m.call.sdp_stream_metadata_changed",
+    CallSDPStreamMetadataChangedPrefix = "org.matrix.call.sdp_stream_metadata_changed",
+    CallReplaces = "m.call.replaces",
+    CallAssertedIdentity = "m.call.asserted_identity",
+    CallAssertedIdentityPrefix = "org.matrix.call.asserted_identity",
+    CallEncryptionKeysPrefix = "io.element.call.encryption_keys",
+    KeyVerificationRequest = "m.key.verification.request",
+    KeyVerificationStart = "m.key.verification.start",
+    KeyVerificationCancel = "m.key.verification.cancel",
+    KeyVerificationMac = "m.key.verification.mac",
+    KeyVerificationDone = "m.key.verification.done",
+    KeyVerificationKey = "m.key.verification.key",
+    KeyVerificationAccept = "m.key.verification.accept",
+    // Not used directly - see READY_TYPE in VerificationRequest.
+    KeyVerificationReady = "m.key.verification.ready",
+    // use of this is discouraged https://matrix.org/docs/spec/client_server/r0.6.1#m-room-message-feedback
+    RoomMessageFeedback = "m.room.message.feedback",
+    Reaction = "m.reaction",
+    PollStart = "org.matrix.msc3381.poll.start",
+    UserVerifyRequest = "m.user.verify.request",
+    UserVerifyAccept = "m.user.verify.accept",
+    UserVerified = "m.user.verified",
+
+    // Room ephemeral events
+    Typing = "m.typing",
+    Receipt = "m.receipt",
+    Presence = "m.presence",
+
+    // Room account_data events
+    FullyRead = "m.fully_read",
+    Tag = "m.tag",
+    SpaceOrder = "org.matrix.msc3230.space_order", // MSC3230
+    MarkedUnread = "m.marked_unread",
+
+    // User account_data events
+    PushRules = "m.push_rules",
+    Direct = "m.direct",
+    IgnoredUserList = "m.ignored_user_list",
+    InvitePermissionConfig = "m.invite_permission_config", // MSC4380
+
+    // to_device events
+    RoomKey = "m.room_key",
+    RoomKeyRequest = "m.room_key_request",
+    ForwardedRoomKey = "m.forwarded_room_key",
+    Dummy = "m.dummy",
+    SecretRequest = "m.secret.request",
+    SecretSend = "m.secret.send",
+
+    // Group call events
+    GroupCallPrefix = "org.matrix.msc3401.call",
+    GroupCallMemberPrefix = "org.matrix.msc3401.call.member",
+
+    // MatrixRTC events
+    RTCMembership = "org.matrix.msc4143.rtc.member",
+    CallNotify = "org.matrix.msc4075.call.notify",
+    RTCNotification = "org.matrix.msc4075.rtc.notification",
+    RTCDecline = "org.matrix.msc4310.rtc.decline",
+
+    // Policy servers
+    RoomPolicy = "org.matrix.msc4284.policy",
+}
+
+export enum RelationType {
+    Annotation = "m.annotation",
+    Replace = "m.replace",
+    Reference = "m.reference",
+
+    // Don't use this yet: it's only the stable version. The code still assumes we support the unstable prefix and,
+    // moreover, our tests currently use the unstable prefix. Use THREAD_RELATION_TYPE.name.
+    // Once we support *only* the stable prefix, THREAD_RELATION_TYPE can die and we can switch to this.
+    Thread = "m.thread",
+}
+
+export enum MsgType {
+    Text = "m.text",
+    Emote = "m.emote",
+    Notice = "m.notice",
+    Image = "m.image",
+    File = "m.file",
+    Audio = "m.audio",
+    Location = "m.location",
+    Video = "m.video",
+    KeyVerificationRequest = "m.key.verification.request",
+}
+
+export const RoomCreateTypeField = "type";
+
+export enum RoomType {
+    Space = "m.space",
+    UnstableCall = "org.matrix.msc3417.call",
+    ElementVideo = "io.element.video",
+}
+
+export const ToDeviceMessageId = "org.matrix.msgid";
+
+/**
+ * Identifier for an [MSC3088](https://github.com/matrix-org/matrix-doc/pull/3088)
+ * room purpose. Note that this reference is UNSTABLE and subject to breaking changes,
+ * including its eventual removal.
+ */
+export const UNSTABLE_MSC3088_PURPOSE = new UnstableValue("m.room.purpose", "org.matrix.msc3088.purpose");
+
+/**
+ * Enabled flag for an [MSC3088](https://github.com/matrix-org/matrix-doc/pull/3088)
+ * room purpose. Note that this reference is UNSTABLE and subject to breaking changes,
+ * including its eventual removal.
+ */
+export const UNSTABLE_MSC3088_ENABLED = new UnstableValue("m.enabled", "org.matrix.msc3088.enabled");
+
+/**
+ * Subtype for an [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) space-room.
+ * Note that this reference is UNSTABLE and subject to breaking changes, including its
+ * eventual removal.
+ */
+export const UNSTABLE_MSC3089_TREE_SUBTYPE = new UnstableValue("m.data_tree", "org.matrix.msc3089.data_tree");
+
+/**
+ * Leaf type for an event in a [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) space-room.
+ * Note that this reference is UNSTABLE and subject to breaking changes, including its
+ * eventual removal.
+ */
+export const UNSTABLE_MSC3089_LEAF = new UnstableValue("m.leaf", "org.matrix.msc3089.leaf");
+
+/**
+ * Branch (Leaf Reference) type for the index approach in a
+ * [MSC3089](https://github.com/matrix-org/matrix-doc/pull/3089) space-room. Note that this reference is
+ * UNSTABLE and subject to breaking changes, including its eventual removal.
+ */
+export const UNSTABLE_MSC3089_BRANCH = new UnstableValue("m.branch", "org.matrix.msc3089.branch");
+
+/**
+ * Marker event type to point back at imported historical content in a room. See
+ * [MSC2716](https://github.com/matrix-org/matrix-spec-proposals/pull/2716).
+ * Note that this reference is UNSTABLE and subject to breaking changes,
+ * including its eventual removal.
+ */
+export const UNSTABLE_MSC2716_MARKER = new UnstableValue("m.room.marker", "org.matrix.msc2716.marker");
+
+/**
+ * Name of the request property for relation based redactions.
+ * {@link https://github.com/matrix-org/matrix-spec-proposals/pull/3912}
+ */
+export const MSC3912_RELATION_BASED_REDACTIONS_PROP = new UnstableValue(
+    "with_rel_types",
+    "org.matrix.msc3912.with_relations",
+);
+
+/**
+ * Functional members type for declaring a purpose of room members (e.g. helpful bots).
+ * Note that this reference is UNSTABLE and subject to breaking changes, including its
+ * eventual removal.
+ *
+ * Schema (TypeScript):
+ * ```
+ * {
+ *   service_members?: string[]
+ * }
+ * ```
+ *
+ * @example
+ * ```
+ * {
+ *   "service_members": [
+ *     "@helperbot:localhost",
+ *     "@reminderbot:alice.tdl"
+ *   ]
+ * }
+ * ```
+ */
+export const UNSTABLE_ELEMENT_FUNCTIONAL_USERS = new UnstableValue(
+    "io.element.functional_members",
+    "io.element.functional_members",
+);
+
+/**
+ * A type of message that affects visibility of a message,
+ * as per https://github.com/matrix-org/matrix-doc/pull/3531
+ *
+ * @experimental
+ */
+export const EVENT_VISIBILITY_CHANGE_TYPE = new UnstableValue("m.visibility", "org.matrix.msc3531.visibility");
+
+/**
+ * https://github.com/matrix-org/matrix-doc/pull/3881
+ *
+ * @experimental
+ */
+export const PUSHER_ENABLED = new UnstableValue("enabled", "org.matrix.msc3881.enabled");
+
+/**
+ * https://github.com/matrix-org/matrix-doc/pull/3881
+ *
+ * @experimental
+ */
+export const PUSHER_DEVICE_ID = new UnstableValue("device_id", "org.matrix.msc3881.device_id");
+
+/**
+ * https://github.com/matrix-org/matrix-doc/pull/3890
+ *
+ * @experimental
+ */
+export const LOCAL_NOTIFICATION_SETTINGS_PREFIX = new UnstableValue(
+    "m.local_notification_settings",
+    "org.matrix.msc3890.local_notification_settings",
+);
+
+/**
+ * https://github.com/matrix-org/matrix-doc/pull/4023
+ *
+ * @experimental
+ */
+export const UNSIGNED_THREAD_ID_FIELD = new UnstableValue("thread_id", "org.matrix.msc4023.thread_id");
+
+/**
+ * https://github.com/matrix-org/matrix-spec-proposals/pull/4115
+ *
+ * @experimental
+ */
+export const UNSIGNED_MEMBERSHIP_FIELD = new NamespacedValue("membership", "io.element.msc4115.membership");
+
+/**
+ * Mapped type from event type to content type for all specified non-state room events.
+ */
+export interface TimelineEvents {
+    [EventType.RoomMessage]: RoomMessageEventContent;
+    [EventType.Sticker]: StickerEventContent;
+    [EventType.Reaction]: ReactionEventContent;
+    [EventType.CallReplaces]: MCallReplacesEvent;
+    [EventType.CallAnswer]: MCallAnswer;
+    [EventType.CallSelectAnswer]: MCallSelectAnswer;
+    [EventType.CallNegotiate]: Omit<MCallInviteNegotiate, "offer">;
+    [EventType.CallInvite]: MCallInviteNegotiate;
+    [EventType.CallCandidates]: MCallCandidates;
+    [EventType.CallHangup]: MCallHangupReject;
+    [EventType.CallReject]: MCallHangupReject;
+    [EventType.CallSDPStreamMetadataChangedPrefix]: MCallBase &
+        EitherAnd<
+            { sdp_stream_metadata: SDPStreamMetadata },
+            { "org.matrix.msc3077.sdp_stream_metadata": SDPStreamMetadata }
+        >;
+    [EventType.CallSDPStreamMetadataChanged]: MCallBase &
+        EitherAnd<
+            { sdp_stream_metadata: SDPStreamMetadata },
+            { "org.matrix.msc3077.sdp_stream_metadata": SDPStreamMetadata }
+        >;
+    [EventType.CallEncryptionKeysPrefix]: EncryptionKeysEventContent;
+    [EventType.CallNotify]: ICallNotifyContent;
+    [EventType.RTCNotification]: IRTCNotificationContent;
+    [EventType.RTCDecline]: IRTCDeclineContent;
+    [M_BEACON.name]: MBeaconEventContent;
+    [M_POLL_START.name]: PollStartEventContent;
+    [M_POLL_END.name]: PollEndEventContent;
+    [EventType.RTCMembership]: RtcMembershipData | { msc4354_sticky_key: string }; // An object containing just the sticky key is empty.
+    [EventType.UserVerifyRequest]: {
+        tx_hash: string;
+        issuer_xrpl_address: string;
+        target_xrpl_address: string;
+        credential_type_bytes?: "textrp_verify";
+        trust_model?: "nft_metadata";
+    };
+    [EventType.UserVerifyAccept]: {
+        tx_hash: string;
+        issuer_xrpl_address: string;
+        accepter_xrpl_address: string;
+        credential_type_bytes?: "textrp_verify";
+        trust_model?: "nft_metadata";
+        nft_token_id?: string;
+        ipfs_uri?: string;
+    };
+}
+
+/**
+ * Mapped type from event type to content type for all specified room state events.
+ */
+export interface StateEvents {
+    [EventType.RoomCanonicalAlias]: RoomCanonicalAliasEventContent;
+    [EventType.RoomCreate]: RoomCreateEventContent;
+    [EventType.RoomJoinRules]: RoomJoinRulesEventContent;
+    [EventType.RoomMember]: RoomMemberEventContent;
+    // XXX: Spec says this event has 3 required fields but kicking such an invitation requires sending `{}`
+    [EventType.RoomThirdPartyInvite]: RoomThirdPartyInviteEventContent | EmptyObject;
+    [EventType.RoomPowerLevels]: RoomPowerLevelsEventContent;
+    [EventType.RoomName]: RoomNameEventContent;
+    [EventType.RoomTopic]: RoomTopicEventContent;
+    [EventType.RoomAvatar]: RoomAvatarEventContent;
+    [EventType.RoomPinnedEvents]: RoomPinnedEventsEventContent;
+    [EventType.RoomEncryption]: RoomEncryptionEventContent;
+    [EventType.RoomHistoryVisibility]: RoomHistoryVisibilityEventContent;
+    [EventType.RoomGuestAccess]: RoomGuestAccessEventContent;
+    [EventType.RoomServerAcl]: RoomServerAclEventContent;
+    [EventType.RoomTombstone]: RoomTombstoneEventContent;
+    [EventType.SpaceChild]: SpaceChildEventContent;
+    [EventType.SpaceParent]: SpaceParentEventContent;
+
+    [EventType.PolicyRuleUser]: PolicyRuleEventContent | EmptyObject;
+    [EventType.PolicyRuleRoom]: PolicyRuleEventContent | EmptyObject;
+    [EventType.PolicyRuleServer]: PolicyRuleEventContent | EmptyObject;
+
+    // MSC4284: Policy servers
+    [EventType.RoomPolicy]: RoomPolicyContent | EmptyObject;
+
+    // MSC3401
+    [EventType.GroupCallPrefix]: IGroupCallRoomState;
+    [EventType.GroupCallMemberPrefix]: IGroupCallRoomMemberState | SessionMembershipData | EmptyObject;
+    [EventType.RTCMembership]: RtcMembershipData | EmptyObject;
+    // MSC3089
+    [UNSTABLE_MSC3089_BRANCH.name]: MSC3089EventContent;
+
+    // MSC3672
+    [M_BEACON_INFO.name]: MBeaconInfoEventContent;
+    [EventType.UserVerified]: {
+        status: "requested" | "verified";
+        credential_type?: "textrp_verify";
+        trust_model?: "nft_metadata";
+        tx_hash: string;
+        validated: boolean;
+        [key: string]: unknown;
+    };
+}
+
+/**
+ * Mapped type from event type to content type for all specified room-specific account_data events.
+ */
+export interface RoomAccountDataEvents extends SecretStorageAccountDataEvents {
+    [EventType.FullyRead]: { event_id: string };
+    [EventType.Tag]: { tags: { [name: string]: { order?: number } } };
+    [EventType.SpaceOrder]: { order: string };
+    [EventType.MarkedUnread]: { unread: boolean };
+}
+
+/**
+ * Mapped type from event type to content type for all specified global account_data events.
+ */
+export interface AccountDataEvents extends SecretStorageAccountDataEvents {
+    [EventType.PushRules]: IPushRules;
+    [EventType.Direct]: { [userId: string]: string[] };
+    [EventType.IgnoredUserList]: { ignored_users: { [userId: string]: EmptyObject } };
+    "m.secret_storage.default_key": { key: string };
+    // Flag set by the rust SDK (Element X) and also used by us to mark that the user opted out of backup
+    // (I don't know why it's m.org.matrix...)
+    "m.org.matrix.custom.backup_disabled": { disabled: boolean };
+    "m.identity_server": { base_url: string | null };
+    [key: `${typeof LOCAL_NOTIFICATION_SETTINGS_PREFIX.name}.${string}`]: LocalNotificationSettings;
+    [key: `m.secret_storage.key.${string}`]: SecretStorageKeyDescription;
+
+    // Invites-ignorer events
+    [POLICIES_ACCOUNT_EVENT_TYPE.name]: { [key: string]: any };
+    [POLICIES_ACCOUNT_EVENT_TYPE.altName]: { [key: string]: any };
+
+    [EventType.InvitePermissionConfig]: { default_action?: string };
+}
+
+/**
+ * Subset of AccountDataEvents, excluding events specified in https://spec.matrix.org/v1.17/client-server-api/#server-behaviour-12
+ */
+export type WritableAccountDataEvents = Exclude<AccountDataEvents, "m.fully_read" | "m.push_rules">;
+
+/**
+ * Mapped type from event type to content type for all specified global events encrypted by secret storage.
+ *
+ * See https://spec.matrix.org/v1.13/client-server-api/#msecret_storagev1aes-hmac-sha2-1
+ */
+export interface SecretStorageAccountDataEvents {
+    "m.megolm_backup.v1": SecretInfo;
+    "m.cross_signing.master": SecretInfo;
+    "m.cross_signing.self_signing": SecretInfo;
+    "m.cross_signing.user_signing": SecretInfo;
+    "org.matrix.msc3814": SecretInfo;
+}