matrix-js-sdk 42.4.0 → 43.0.0

package/lib/matrixrtc/types.d.ts

@@ -1,6 +1,8 @@
-import type { IContent, IMentions } from "../matrix.ts";
+import type { IMentions } from "../matrix.ts";
 import type { RelationEvent } from "../types.ts";
-import type { CallMembership } from "./CallMembership.ts";
+import type { MatrixEvent } from "../models/event.ts";
+import type { Room } from "../models/room.ts";
+import { CallMembership } from "./CallMembership.ts";
 import { type CallMembershipIdentityParts } from "./EncryptionManager.ts";
 export type EncryptionKeyMapKey = string;
 export interface EncryptionKeyEntry {
@@ -79,32 +81,122 @@ export type RTCNotificationType = "ring" | "notification";
  */
 export type RTCCallIntent = "audio" | "video" | string;
 /**
- * This will check if the content has all the expected fields to be a valid IRTCNotificationContent.
- * It will also cap the lifetime to 90000ms (1.5 min) if a higher value is provided.
- * @param content
- * @throws if the content is invalid
- * @returns a parsed IRTCNotificationContent
+ * The maximum `lifetime` of an RTC notification as per MSC4075. Larger values are capped to this.
+ *
+ * Exported for use within the js-sdk only. Not re-exported from `matrixrtc/index.ts`.
+ * @internal
  */
-export declare function parseCallNotificationContent(content: IContent): IRTCNotificationContent;
+export declare const RTC_NOTIFICATION_MAX_LIFETIME_MS: number;
+/**
+ * The maximum amount by which a notification's `sender_ts` may lie ahead of its `origin_server_ts`
+ * before the `lifetime` is measured from `origin_server_ts` instead, as per MSC4075.
+ *
+ * Exported for use within the js-sdk only. Not re-exported from `matrixrtc/index.ts`.
+ * @internal
+ */
+export declare const RTC_NOTIFICATION_MAX_SENDER_TS_AHEAD_MS: number;
+/**
+ * The context that is needed to evaluate the MSC4075 rules for receiving notifications.
+ */
+export interface RTCNotificationValidationContext {
+    /** The room in which the notification was received. */
+    room: Pick<Room, "getLiveTimeline" | "getUnfilteredTimelineSet" | "_unstable_getStickyEvents" | "_unstable_getKeyedStickyEvent">;
+    /** The user ID of the receiving (local) user. */
+    userId: string;
+    /** The current time in milliseconds since the epoch. Defaults to `Date.now()`. */
+    now?: number;
+}
+/**
+ * Computes the absolute timestamp at which an RTC notification stops being valid, as per MSC4075.
+ *
+ * The `lifetime` is measured from `sender_ts` unless `sender_ts` lies more than 20 seconds ahead of
+ * `origin_server_ts`, in which case it is measured from `origin_server_ts` instead. Regardless of the basis,
+ * the remaining lifetime is capped at 2 minutes.
+ *
+ * @param content The notification content.
+ * @param originServerTs The `origin_server_ts` of the notification event.
+ * @param now The current time in milliseconds since the epoch. Defaults to `Date.now()`.
+ * @returns The timestamp (in milliseconds since the epoch) at which the notification expires.
+ */
+export declare function getCallNotificationExpiry(content: Pick<IRTCNotificationContent, "sender_ts" | "lifetime">, originServerTs: number, now?: number): number;
+/**
+ * The subset of a notification event that {@link parseCallNotificationContent} needs.
+ */
+type RTCNotificationEvent = Pick<MatrixEvent, "getContent" | "getId" | "getSender" | "getTs" | "getType" | "unstableStickyInfo">;
+/**
+ * Parses the content of a received `org.matrix.msc4075.rtc.notification` event.
+ *
+ * This checks that the content matches the schema of MSC4075, caps `lifetime` to 2 minutes and applies
+ * the rules for receiving invites from MSC4075.
+ * The notification is only considered valid if all of the following hold:
+ * - It wasn't sent by the receiving user.
+ * - It is the current entry in the room's sticky event map for its sender and slot and isn't a withdrawal.
+ * - The slot it refers to exists and is open.
+ * - Its lifetime hasn't elapsed (see {@link getCallNotificationExpiry}).
+ * - Its `m.mentions` target the receiving user, either directly or via a room mention that the sender is
+ *   allowed to trigger.
+ * - The receiving user has no joined `m.rtc.member` event for the slot in the sticky event map.
+ * - Any left `m.rtc.member` event of the receiving user for the slot predates the notification.
+ * - The receiving user has no sticky decline event referencing the notification.
+ *
+ * @param event The notification event.
+ * @param context The context needed to evaluate the receiving rules.
+ * @throws if the content is malformed or the notification isn't valid.
+ * @returns A promise resolving to the parsed content.
+ */
+export declare function parseCallNotificationContent(event: RTCNotificationEvent, context: RTCNotificationValidationContext): Promise<IRTCNotificationContent>;
 /**
  * Interface for `org.matrix.msc4075.rtc.notification` events.
  * Don't cast event content to this directly. Use `parseCallNotificationContent` instead to validate the content first.
  */
 export interface IRTCNotificationContent extends RelationEvent {
-    "m.mentions"?: IMentions;
-    "notification_type": RTCNotificationType;
     /**
-     * The initial intent of the calling user.
+     * The `state_key` of the `m.rtc.slot` event that the notification refers to.
+     *
+     * Notifications predating this property omit it. `parseCallNotificationContent` fills it in from the
+     * referenced membership event, so the parsed content always carries it.
+     */
+    "slot_id": string;
+    /**
+     * The users targeted by the notification. Must either mention the room or at least one user.
+     */
+    "m.mentions": IMentions;
+    /**
+     * @deprecated Not part of MSC4075 anymore. How to present a notification is up to the receiving client.
+     */
+    "notification_type"?: RTCNotificationType;
+    /**
+     * @deprecated Not part of MSC4075 anymore. The initial intent of the calling user.
      */
     "m.call.intent"?: RTCCallIntent;
+    /**
+     * The timestamp (in milliseconds since the epoch) at which the sending client created the event.
+     */
     "sender_ts": number;
+    /**
+     * The time (in milliseconds) that the notification is valid for, measured from `sender_ts`.
+     */
     "lifetime": number;
+    /**
+     * The sticky key as per MSC4354. Must be equal to `slot_id`.
+     *
+     * Optional because notifications predating MSC4354 omit it.
+     */
+    "msc4354_sticky_key"?: string;
 }
 /**
  * MSC4310 decline event content for `org.matrix.msc4310.rtc.decline`.
  * Sent as a standard m.reference relation to an `org.matrix.msc4075.rtc.notification` event.
  */
 export interface IRTCDeclineContent extends RelationEvent {
+    /**
+     * The sticky key as per MSC4354. Must be equal to the event ID of the notification being declined.
+     *
+     * Optional because servers without MSC4354 support can't deliver the decline as a sticky event. Such a
+     * decline still counts, but only for devices that receive it directly, since it isn't re-delivered after
+     * a gappy or initial sync.
+     */
+    msc4354_sticky_key?: string;
 }
 export declare enum Status {
     Disconnected = "Disconnected",
@@ -179,4 +271,5 @@ export interface SlotDescription {
      */
     id: string;
 }
+export {};
 //# sourceMappingURL=types.d.ts.map

package/lib/matrixrtc/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/matrixrtc/types.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAE1E,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACnC,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC7B,UAAU,EAAE,2BAA2B,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACpC,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEzC,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IAC/C,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACrC,MAAM,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QAGX,iBAAiB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACL,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;IAEF,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AACD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,CAAC;AAC/C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,SAAS,CAAC;IACxB,aAAa,EAAE,cAAc,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,cAAc,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;AAEvD;;;;;;GAMG;AACH,wBAAgB,4BAA4B,CAAC,OAAO,EAAE,QAAQ,GAAG,uBAAuB,CAuBvF;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC1D,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,mBAAmB,EAAE,mBAAmB,CAAC;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;CAAG;AAE5D,oBAAY,MAAM;IACd,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,EAAE;QACN;;WAEG;QACH,2BAA2B,EAAE,MAAM,CAAC;QACpC;;WAEG;QACH,+BAA+B,EAAE,MAAM,CAAC;KAC3C,CAAC;IACF,MAAM,EAAE;QACJ;;;WAGG;QACH,uCAAuC,EAAE,MAAM,CAAC;KACnD,CAAC;CACL,CAAC;AAEF,eAAO,MAAM,cAAc,MAAO,cAAc,UAAU,MAAM,YAAY,MAAM,KAAG,OACnC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC1D,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC1B,WAAW,CAAC,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAC3C,UAAU,CAAC,EAAE,wBAAwB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAChE,IAAI,EAAE,CAAC,CAAC;IAER,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,eAAO,MAAM,8BAA8B,kCAAkC,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,OAAO,8BAA8B,CAAC;IAE5C,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACd"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/matrixrtc/types.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAY,SAAS,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAG9C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,EAAE,KAAK,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAI1E,MAAM,MAAM,mBAAmB,GAAG,MAAM,CAAC;AAEzC,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACnC,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC7B,UAAU,EAAE,2BAA2B,CAAC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACpC,GAAG,EAAE,UAAU,CAAC,WAAW,CAAC,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IAEnB,UAAU,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAEzC,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,kBAAkB,EAAE,CAAC;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,kCAAkC;IAC/C,IAAI,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IACrC,MAAM,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QAGX,iBAAiB,EAAE,MAAM,CAAC;KAC7B,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE;QACL,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,EAAE,MAAM,CAAC;KACjB,CAAC;IAEF,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AACD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,QAAQ,CAAC;AAC/C;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,YAAY,EAAE,SAAS,CAAC;IACxB,aAAa,EAAE,cAAc,CAAC;IAC9B,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,MAAM,mBAAmB,GAAG,MAAM,GAAG,cAAc,CAAC;AAE1D;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,CAAC;AAEvD;;;;;GAKG;AACH,eAAO,MAAM,gCAAgC,QAAgB,CAAC;AAE9D;;;;;;GAMG;AACH,eAAO,MAAM,uCAAuC,QAAY,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC7C,uDAAuD;IACvD,IAAI,EAAE,IAAI,CACN,IAAI,EACJ,iBAAiB,GAAG,0BAA0B,GAAG,2BAA2B,GAAG,+BAA+B,CACjH,CAAC;IACF,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;IACf,kFAAkF;IAClF,GAAG,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,yBAAyB,CACrC,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,WAAW,GAAG,UAAU,CAAC,EAChE,cAAc,EAAE,MAAM,EACtB,GAAG,GAAE,MAAmB,GACzB,MAAM,CAMR;AAED;;GAEG;AACH,KAAK,oBAAoB,GAAG,IAAI,CAC5B,WAAW,EACX,YAAY,GAAG,OAAO,GAAG,WAAW,GAAG,OAAO,GAAG,SAAS,GAAG,oBAAoB,CACpF,CAAC;AA+DF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,4BAA4B,CAC9C,KAAK,EAAE,oBAAoB,EAC3B,OAAO,EAAE,gCAAgC,GAC1C,OAAO,CAAC,uBAAuB,CAAC,CAiDlC;AA0HD;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,aAAa;IAC1D;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,EAAE,SAAS,CAAC;IACxB;;OAEG;IACH,mBAAmB,CAAC,EAAE,mBAAmB,CAAC;IAC1C;;OAEG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;CACjC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACrD;;;;;;OAMG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,oBAAY,MAAM;IACd,YAAY,iBAAiB;IAC7B,UAAU,eAAe;IACzB,SAAS,cAAc;IACvB,aAAa,kBAAkB;IAC/B,OAAO,YAAY;CACtB;AAED;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG;IACrB,QAAQ,EAAE;QACN;;WAEG;QACH,2BAA2B,EAAE,MAAM,CAAC;QACpC;;WAEG;QACH,+BAA+B,EAAE,MAAM,CAAC;KAC3C,CAAC;IACF,MAAM,EAAE;QACJ;;;WAGG;QACH,uCAAuC,EAAE,MAAM,CAAC;KACnD,CAAC;CACL,CAAC;AAEF,eAAO,MAAM,cAAc,MAAO,cAAc,UAAU,MAAM,YAAY,MAAM,KAAG,OACnC,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,SAAS;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAC1D,MAAM,EAAE,MAAM,GAAG,QAAQ,CAAC;IAC1B,WAAW,CAAC,EAAE,yBAAyB,CAAC,CAAC,CAAC,CAAC;IAC3C,UAAU,CAAC,EAAE,wBAAwB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB,CAAC,CAAC,SAAS,MAAM,GAAG,MAAM;IAChE,IAAI,EAAE,CAAC,CAAC;IAER,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED,eAAO,MAAM,8BAA8B,kCAAkC,CAAC;AAE9E;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,IAAI,EAAE,OAAO,8BAA8B,CAAC;IAE5C,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;CACd"}

package/lib/matrixrtc/types.js

@@ -15,6 +15,12 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+import { EventTimeline } from "../models/event-timeline.js";
+import { EventType, RelationType } from "../@types/event.js";
+import { CallMembership } from "./CallMembership.js";
+import { isLeftMembershipContent } from "./membershipData/index.js";
+import { isSlotOpen, slotIdToDescription } from "./utils.js";
+
 /**
  * The mxID, deviceId and membership timestamp of a RTC session participant.
  */
@@ -45,35 +51,273 @@ limitations under the License.
  */
 
 /**
- * This will check if the content has all the expected fields to be a valid IRTCNotificationContent.
- * It will also cap the lifetime to 90000ms (1.5 min) if a higher value is provided.
- * @param content
- * @throws if the content is invalid
- * @returns a parsed IRTCNotificationContent
+ * The maximum `lifetime` of an RTC notification as per MSC4075. Larger values are capped to this.
+ *
+ * Exported for use within the js-sdk only. Not re-exported from `matrixrtc/index.ts`.
+ * @internal
+ */
+export const RTC_NOTIFICATION_MAX_LIFETIME_MS = 2 * 60 * 1000; // 2 minutes
+
+/**
+ * The maximum amount by which a notification's `sender_ts` may lie ahead of its `origin_server_ts`
+ * before the `lifetime` is measured from `origin_server_ts` instead, as per MSC4075.
+ *
+ * Exported for use within the js-sdk only. Not re-exported from `matrixrtc/index.ts`.
+ * @internal
+ */
+export const RTC_NOTIFICATION_MAX_SENDER_TS_AHEAD_MS = 20 * 1000; // 20 seconds
+
+/**
+ * The context that is needed to evaluate the MSC4075 rules for receiving notifications.
+ */
+
+/**
+ * Computes the absolute timestamp at which an RTC notification stops being valid, as per MSC4075.
+ *
+ * The `lifetime` is measured from `sender_ts` unless `sender_ts` lies more than 20 seconds ahead of
+ * `origin_server_ts`, in which case it is measured from `origin_server_ts` instead. Regardless of the basis,
+ * the remaining lifetime is capped at 2 minutes.
+ *
+ * @param content The notification content.
+ * @param originServerTs The `origin_server_ts` of the notification event.
+ * @param now The current time in milliseconds since the epoch. Defaults to `Date.now()`.
+ * @returns The timestamp (in milliseconds since the epoch) at which the notification expires.
+ */
+export function getCallNotificationExpiry(content, originServerTs, now = Date.now()) {
+  const basis = content.sender_ts - originServerTs > RTC_NOTIFICATION_MAX_SENDER_TS_AHEAD_MS ? originServerTs : content.sender_ts;
+  return Math.min(basis + content.lifetime, now + RTC_NOTIFICATION_MAX_LIFETIME_MS);
+}
+
+/**
+ * The subset of a notification event that {@link parseCallNotificationContent} needs.
+ */
+
+/**
+ * Whether the content marks a withdrawn sticky event (MSC4354), i.e. it is empty apart from the sticky key.
+ */
+function isWithdrawal(content) {
+  return Object.keys(content).every(key => key === "msc4354_sticky_key");
+}
+function isNonNegativeInteger(value) {
+  return Number.isInteger(value) && value >= 0;
+}
+
+/**
+ * Looks up a legacy `m.call.member` state event by ID in the room's current state.
+ *
+ * @returns The event, or `undefined` if no current membership state event has that ID.
+ */
+function findMembershipStateEvent(room, eventId) {
+  const roomState = room.getLiveTimeline().getState(EventTimeline.FORWARDS);
+  return roomState?.getStateEvents(EventType.GroupCallMemberPrefix).find(event => event.getId() === eventId);
+}
+
+/**
+ * Determines the ID of the slot that a notification invites to.
+ *
+ * Notifications predating the `slot_id` property instead carry an `m.reference` relation to the sender's
+ * membership event.
+ *
+ * @throws if the slot can't be determined.
+ * @returns A promise resolving to the slot ID.
+ */
+async function resolveSlotId(content, room) {
+  if (typeof content["slot_id"] === "string") {
+    // Throws if the ID is malformed, e.g. because it contains more than one "#".
+    slotIdToDescription(content["slot_id"]);
+    return content["slot_id"];
+  }
+  if (content["slot_id"] !== undefined) throw new Error("Invalid slot_id");
+  const relation = content["m.relates_to"];
+  const membershipEventId = relation?.rel_type === RelationType.Reference ? relation.event_id : undefined;
+  if (typeof membershipEventId !== "string") {
+    throw new Error("Missing slot_id and no m.reference relation to derive it from");
+  }
+  const membershipEvent = findMembershipStateEvent(room, membershipEventId);
+  if (!membershipEvent) {
+    throw new Error(`Missing slot_id and referenced event ${membershipEventId} is not a current membership`);
+  }
+  try {
+    return (await CallMembership.parseFromEvent(membershipEvent)).slotId;
+  } catch (cause) {
+    throw new Error(`Missing slot_id and referenced event ${membershipEventId} is not a valid membership`, {
+      cause
+    });
+  }
+}
+
+/**
+ * Parses the content of a received `org.matrix.msc4075.rtc.notification` event.
+ *
+ * This checks that the content matches the schema of MSC4075, caps `lifetime` to 2 minutes and applies
+ * the rules for receiving invites from MSC4075.
+ * The notification is only considered valid if all of the following hold:
+ * - It wasn't sent by the receiving user.
+ * - It is the current entry in the room's sticky event map for its sender and slot and isn't a withdrawal.
+ * - The slot it refers to exists and is open.
+ * - Its lifetime hasn't elapsed (see {@link getCallNotificationExpiry}).
+ * - Its `m.mentions` target the receiving user, either directly or via a room mention that the sender is
+ *   allowed to trigger.
+ * - The receiving user has no joined `m.rtc.member` event for the slot in the sticky event map.
+ * - Any left `m.rtc.member` event of the receiving user for the slot predates the notification.
+ * - The receiving user has no sticky decline event referencing the notification.
+ *
+ * @param event The notification event.
+ * @param context The context needed to evaluate the receiving rules.
+ * @throws if the content is malformed or the notification isn't valid.
+ * @returns A promise resolving to the parsed content.
  */
-export function parseCallNotificationContent(content) {
-  if (content["m.mentions"] && typeof content["m.mentions"] !== "object") {
-    throw new Error("malformed m.mentions");
+export async function parseCallNotificationContent(event, context) {
+  if (event.getType() !== EventType.RTCNotification) {
+    throw new Error(`Event ${event.getId()} is not an ${EventType.RTCNotification} event`);
   }
-  if (typeof content["notification_type"] !== "string") {
-    throw new Error("Missing or invalid notification_type");
+  const content = event.getContent();
+  if (isWithdrawal(content)) {
+    throw new Error("Notification was withdrawn");
   }
-  if (typeof content["sender_ts"] !== "number") {
+  const slotId = await resolveSlotId(content, context.room);
+  // The sticky key is only validated when present. A notification predating it can still be valid, and one
+  // carrying the wrong key is filed under that key in the sticky event map, so the lookup below rejects it.
+  if (content["msc4354_sticky_key"] !== undefined && content["msc4354_sticky_key"] !== slotId) {
+    throw new Error("msc4354_sticky_key must be equal to slot_id");
+  }
+  if (!isNonNegativeInteger(content["sender_ts"])) {
     throw new Error("Missing or invalid sender_ts");
   }
-  if (typeof content["lifetime"] !== "number") {
+  if (!isNonNegativeInteger(content["lifetime"])) {
     throw new Error("Missing or invalid lifetime");
   }
-  if (content["relation"] && content["relation"]["rel_type"] !== "m.reference") {
-    throw new Error("Invalid relation");
+  const mentions = content["m.mentions"];
+  if (typeof mentions !== "object" || mentions === null) {
+    throw new Error("Missing or malformed m.mentions");
+  }
+  if (mentions.room !== undefined && typeof mentions.room !== "boolean") {
+    throw new Error("malformed m.mentions.room");
+  }
+  if (mentions.user_ids !== undefined && (!Array.isArray(mentions.user_ids) || !mentions.user_ids.every(userId => typeof userId === "string"))) {
+    throw new Error("malformed m.mentions.user_ids");
   }
-  if (content["m.call.intent"] && typeof content["m.call.intent"] !== "string") {
-    throw new Error("Invalid m.call.intent");
+  if (mentions.room !== true && !mentions.user_ids?.length) {
+    throw new Error("m.mentions must target either the room or at least one user");
   }
-  const cappedLifetime = content["lifetime"] >= 90000 ? 90000 : content["lifetime"];
-  return _objectSpread(_objectSpread({}, content), {}, {
-    lifetime: cappedLifetime
+  const parsed = _objectSpread(_objectSpread({}, content), {}, {
+    slot_id: slotId,
+    lifetime: Math.min(content["lifetime"], RTC_NOTIFICATION_MAX_LIFETIME_MS)
   });
+  await checkCallNotificationReceivingRules(parsed, event, context);
+  return parsed;
+}
+
+/**
+ * Applies the MSC4075 rules for receiving invites to an already schema-validated notification.
+ * @throws if any of the rules is violated.
+ */
+async function checkCallNotificationReceivingRules(content, event, {
+  room,
+  userId,
+  now = Date.now()
+}) {
+  const eventId = event.getId();
+  const sender = event.getSender();
+  if (eventId === undefined || sender === undefined) {
+    throw new Error("Notification event is missing its event ID or sender");
+  }
+  const originServerTs = event.getTs();
+  const slotId = content.slot_id;
+  if (sender === userId) {
+    throw new Error("Notification was sent by the receiving user");
+  }
+
+  // A notification that wasn't delivered as a sticky event can't be superseded or withdrawn, so there is
+  // nothing to check. It isn't in the sticky event map either, which is why this can't be checked blindly.
+  if (event.unstableStickyInfo !== undefined) {
+    if (room._unstable_getKeyedStickyEvent(sender, event.getType(), slotId)?.getId() !== eventId) {
+      throw new Error("Notification is not the current sticky event for its sender and slot");
+    }
+  }
+
+  // `isSlotOpen` returns undefined when no slot event exists at all, which is just as disqualifying.
+  if (!isSlotOpen(room, slotIdToDescription(slotId))) {
+    throw new Error(`Slot ${slotId} does not exist or is closed`);
+  }
+  const roomState = room.getLiveTimeline().getState(EventTimeline.FORWARDS);
+  if (now >= getCallNotificationExpiry(content, originServerTs, now)) {
+    throw new Error("Notification has expired");
+  }
+  const mentions = content["m.mentions"];
+  const mentionsUser = mentions.user_ids?.includes(userId) ?? false;
+  const mentionsRoom = mentions.room === true && (roomState?.mayTriggerNotifOfType("room", sender) ?? false);
+  if (!mentionsUser && !mentionsRoom) {
+    throw new Error("Notification does not mention the receiving user");
+  }
+  for (const membershipEvent of ownMembershipEvents(room, userId)) {
+    const membershipContent = membershipEvent.getContent();
+    if (isLeftMembershipContent(membershipContent)) {
+      if (membershipContent.slot_id === slotId && membershipEvent.getTs() >= originServerTs) {
+        throw new Error(`Receiving user left slot ${slotId} after the notification was sent`);
+      }
+    } else if (await isJoinedToSlot(membershipEvent, slotId, now)) {
+      throw new Error(`Receiving user is already joined to slot ${slotId}`);
+    }
+  }
+  if (hasDeclined(room, userId, eventId)) {
+    throw new Error("Receiving user declined the notification");
+  }
+}
+
+/**
+ * Yields the receiving user's own MatrixRTC membership events, from both the sticky event map and the legacy
+ * member state events. Sessions that don't use sticky events keep membership in state, so both have to be
+ * consulted to tell whether the user is in a session.
+ *
+ * @yields the user's own `m.rtc.member` and `m.call.member` events.
+ */
+function* ownMembershipEvents(room, userId) {
+  for (const stickyEvent of room._unstable_getStickyEvents()) {
+    if (stickyEvent.getType() === EventType.RTCMembership && stickyEvent.getSender() === userId) {
+      yield stickyEvent;
+    }
+  }
+  const roomState = room.getLiveTimeline().getState(EventTimeline.FORWARDS);
+  for (const stateEvent of roomState?.getStateEvents(EventType.GroupCallMemberPrefix) ?? []) {
+    if (stateEvent.getSender() === userId) yield stateEvent;
+  }
+}
+
+/**
+ * Whether the given membership event places its sender in the given slot, i.e. it is a valid, unexpired
+ * membership for that slot.
+ */
+async function isJoinedToSlot(membershipEvent, slotId, now) {
+  let membership;
+  try {
+    membership = await CallMembership.parseFromEvent(membershipEvent);
+  } catch {
+    // Not a membership we understand, so it doesn't place the user anywhere.
+    return false;
+  }
+  if (membership.slotId !== slotId) return false;
+
+  // Legacy memberships go stale when the client that sent them disappears without leaving. Honouring an
+  // expired one would suppress notifications for hours.
+  const expiry = membership.getAbsoluteExpiry();
+  return expiry === undefined || expiry > now;
+}
+
+/**
+ * Whether the receiving user has declined the given notification.
+ *
+ * Declines are looked up both through their `m.reference` relation and in the sticky event map. Relations
+ * cover declines that couldn't be sent as sticky events, but only see events that reached the timeline. A
+ * sticky decline delivered after a gappy or initial sync arrives via the sticky section instead, so it is
+ * only in the map.
+ */
+function hasDeclined(room, userId, eventId) {
+  const declines = room.getUnfilteredTimelineSet().relations.getChildEventsForEvent(eventId, RelationType.Reference, EventType.RTCDecline);
+  if (declines?.getRelations().some(decline => decline.getSender() === userId)) return true;
+
+  // Declines are keyed on the event ID of the notification they decline.
+  return room._unstable_getKeyedStickyEvent(userId, EventType.RTCDecline, eventId) !== undefined;
 }
 
 /**

package/lib/matrixrtc/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/matrixrtc/types.ts"],"sourcesContent":["/*\nCopyright 2023-2026 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\nimport type { IContent, IMentions } from \"../matrix.ts\";\nimport type { RelationEvent } from \"../types.ts\";\nimport type { CallMembership } from \"./CallMembership.ts\";\nimport { type CallMembershipIdentityParts } from \"./EncryptionManager.ts\";\n\nexport type EncryptionKeyMapKey = string;\n\nexport interface EncryptionKeyEntry {\n    index: number;\n    key: string;\n}\n\n/**\n * The mxID, deviceId and membership timestamp of a RTC session participant.\n */\nexport type ParticipantDeviceInfo = {\n    userId: string;\n    deviceId: string;\n    membershipTs: number;\n};\n\n/**\n * A type representing the information needed to decrypt video streams.\n */\nexport type InboundEncryptionSession = {\n    key: Uint8Array<ArrayBuffer>;\n    membership: CallMembershipIdentityParts;\n    keyIndex: number;\n    creationTS: number;\n};\n\n/**\n * The information about the key used to encrypt video streams.\n */\nexport type OutboundEncryptionSession = {\n    key: Uint8Array<ArrayBuffer>;\n    creationTS: number;\n    // The devices that this key is shared with.\n    sharedWith: Array<ParticipantDeviceInfo>;\n    // This is an index acting as the id of the key\n    keyId: number;\n};\n\nexport interface EncryptionKeysEventContent {\n    keys: EncryptionKeyEntry[];\n    device_id: string;\n    call_id: string;\n    sent_ts?: number;\n}\n\n/**\n * THe content of a to-device event that contains encryption keys.\n */\nexport interface EncryptionKeysToDeviceEventContent {\n    keys: { index: number; key: string };\n    member: {\n        id: string;\n        // TODO Remove that it is claimed, need to get the sealed sender from decryption info\n        // Or add some validation on it based on the encryption info\n        claimed_device_id: string;\n    };\n    room_id: string;\n    session: {\n        application: string;\n        call_id: string;\n        scope: string;\n    };\n    // Why is this needed?\n    sent_ts?: number;\n}\n/**\n * @deprecated Use `RTCNotificationType` instead.\n */\nexport type CallNotifyType = \"ring\" | \"notify\";\n/**\n * @deprecated Use `IRTCNotificationContent` instead.\n */\nexport interface ICallNotifyContent {\n    \"application\": string;\n    \"m.mentions\": IMentions;\n    \"notify_type\": CallNotifyType;\n    \"call_id\": string;\n}\n\nexport type RTCNotificationType = \"ring\" | \"notification\";\n\n/**\n * Represents the intention of the call from the perspective of the sending user.\n * May be any string, although `\"audio\"` and `\"video\"` are commonly accepted values.\n */\nexport type RTCCallIntent = \"audio\" | \"video\" | string;\n\n/**\n * This will check if the content has all the expected fields to be a valid IRTCNotificationContent.\n * It will also cap the lifetime to 90000ms (1.5 min) if a higher value is provided.\n * @param content\n * @throws if the content is invalid\n * @returns a parsed IRTCNotificationContent\n */\nexport function parseCallNotificationContent(content: IContent): IRTCNotificationContent {\n    if (content[\"m.mentions\"] && typeof content[\"m.mentions\"] !== \"object\") {\n        throw new Error(\"malformed m.mentions\");\n    }\n    if (typeof content[\"notification_type\"] !== \"string\") {\n        throw new Error(\"Missing or invalid notification_type\");\n    }\n    if (typeof content[\"sender_ts\"] !== \"number\") {\n        throw new Error(\"Missing or invalid sender_ts\");\n    }\n    if (typeof content[\"lifetime\"] !== \"number\") {\n        throw new Error(\"Missing or invalid lifetime\");\n    }\n\n    if (content[\"relation\"] && content[\"relation\"][\"rel_type\"] !== \"m.reference\") {\n        throw new Error(\"Invalid relation\");\n    }\n    if (content[\"m.call.intent\"] && typeof content[\"m.call.intent\"] !== \"string\") {\n        throw new Error(\"Invalid m.call.intent\");\n    }\n\n    const cappedLifetime = content[\"lifetime\"] >= 90000 ? 90000 : content[\"lifetime\"];\n    return { ...content, lifetime: cappedLifetime } as IRTCNotificationContent;\n}\n\n/**\n * Interface for `org.matrix.msc4075.rtc.notification` events.\n * Don't cast event content to this directly. Use `parseCallNotificationContent` instead to validate the content first.\n */\nexport interface IRTCNotificationContent extends RelationEvent {\n    \"m.mentions\"?: IMentions;\n    \"notification_type\": RTCNotificationType;\n    /**\n     * The initial intent of the calling user.\n     */\n    \"m.call.intent\"?: RTCCallIntent;\n    \"sender_ts\": number;\n    \"lifetime\": number;\n}\n\n/**\n * MSC4310 decline event content for `org.matrix.msc4310.rtc.decline`.\n * Sent as a standard m.reference relation to an `org.matrix.msc4075.rtc.notification` event.\n */\nexport interface IRTCDeclineContent extends RelationEvent {}\n\nexport enum Status {\n    Disconnected = \"Disconnected\",\n    Connecting = \"Connecting\",\n    Connected = \"Connected\",\n    Disconnecting = \"Disconnecting\",\n    Unknown = \"Unknown\",\n}\n\n/**\n * A type collecting call encryption statistics for a session.\n */\nexport type Statistics = {\n    counters: {\n        /**\n         * The number of times we have sent a room event containing encryption keys.\n         */\n        roomEventEncryptionKeysSent: number;\n        /**\n         * The number of times we have received a room event containing encryption keys.\n         */\n        roomEventEncryptionKeysReceived: number;\n    };\n    totals: {\n        /**\n         * The total age (in milliseconds) of all room events containing encryption keys that we have received.\n         * We track the total age so that we can later calculate the average age of all keys received.\n         */\n        roomEventEncryptionKeysReceivedTotalAge: number;\n    };\n};\n\nexport const isMyMembership = (m: CallMembership, userId: string, deviceId: string): boolean =>\n    m.sender === userId && m.deviceId === deviceId;\n\n/**\n *  A RTC transport is a JSON object that describes how to connect to a RTC member.\n */\nexport interface Transport {\n    type: string;\n    [key: string]: unknown;\n}\n\n/**\n * Event content for `org.matrix.msc4143.rtc.slot` state events.\n */\nexport interface RtcSlotEventContent<T extends string = string> {\n    status: \"open\" | \"closed\";\n    application?: RtcSlotApplicationContent<T>;\n    encryption?: RtcSlotEncryptionContent;\n}\n\n/**\n * Content of the `application` object within `org.matrix.msc4143.rtc.slot` events.\n */\nexport interface RtcSlotApplicationContent<T extends string = string> {\n    type: T;\n    // Other application specific keys.\n    [key: string]: unknown;\n}\n\nexport const RTC_SLOT_ENCRYPTION_PER_MEMBER = \"org.matrix.msc4143.per_member\";\n\n/**\n * Content of the `encryption` object within `org.matrix.msc4143.rtc.slot` events.\n */\nexport interface RtcSlotEncryptionContent {\n    type: typeof RTC_SLOT_ENCRYPTION_PER_MEMBER;\n    // Other encryption-mechanism specific keys.\n    [key: string]: unknown;\n}\n\n/**\n * The session description is used to identify a session. Used in the state event.\n */\nexport interface SlotDescription {\n    /**\n     * The application type. e.g. \"m.call\".\n     */\n    application: string;\n    /**\n     * The application-specific slot ID. e.g. \"ROOM\".\n     */\n    id: string;\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAaA;AACA;AACA;;AAOA;AACA;AACA;;AAQA;AACA;AACA;;AAiBA;AACA;AACA;;AAkBA;AACA;AACA;;AAEA;AACA;AACA;;AAUA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS,4BAA4B,CAAC,OAAiB,EAA2B;EACrF,IAAI,OAAO,CAAC,YAAY,CAAC,IAAI,OAAO,OAAO,CAAC,YAAY,CAAC,KAAK,QAAQ,EAAE;IACpE,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC;EAC3C;EACA,IAAI,OAAO,OAAO,CAAC,mBAAmB,CAAC,KAAK,QAAQ,EAAE;IAClD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC;EAC3D;EACA,IAAI,OAAO,OAAO,CAAC,WAAW,CAAC,KAAK,QAAQ,EAAE;IAC1C,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC;EACnD;EACA,IAAI,OAAO,OAAO,CAAC,UAAU,CAAC,KAAK,QAAQ,EAAE;IACzC,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC;EAClD;EAEA,IAAI,OAAO,CAAC,UAAU,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,CAAC,UAAU,CAAC,KAAK,aAAa,EAAE;IAC1E,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC;EACvC;EACA,IAAI,OAAO,CAAC,eAAe,CAAC,IAAI,OAAO,OAAO,CAAC,eAAe,CAAC,KAAK,QAAQ,EAAE;IAC1E,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC;EAC5C;EAEA,MAAM,cAAc,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,KAAK,GAAG,KAAK,GAAG,OAAO,CAAC,UAAU,CAAC;EACjF,uCAAY,OAAO;IAAE,QAAQ,EAAE;EAAc;AACjD;;AAEA;AACA;AACA;AACA;;AAYA;AACA;AACA;AACA;;AAGA,WAAY,MAAM,0BAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAA,OAAN,MAAM;AAAA;;AAQlB;AACA;AACA;;AAqBA,OAAO,MAAM,cAAc,GAAG,CAAC,CAAiB,EAAE,MAAc,EAAE,QAAgB,KAC9E,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ;;AAElD;AACA;AACA;;AAMA;AACA;AACA;;AAOA;AACA;AACA;;AAOA,OAAO,MAAM,8BAA8B,GAAG,+BAA+B;;AAE7E;AACA;AACA;;AAOA;AACA;AACA","ignoreList":[]}
+{"version":3,"file":"types.js","names":[],"sources":["../../src/matrixrtc/types.ts"],"sourcesContent":["/*\nCopyright 2023-2026 The Matrix.org Foundation C.I.C.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n*/\nimport type { IContent, IMentions } from \"../matrix.ts\";\nimport type { RelationEvent } from \"../types.ts\";\nimport type { MatrixEvent } from \"../models/event.ts\";\nimport type { Room } from \"../models/room.ts\";\nimport { EventTimeline } from \"../models/event-timeline.ts\";\nimport { EventType, RelationType } from \"../@types/event.ts\";\nimport { CallMembership } from \"./CallMembership.ts\";\nimport { type CallMembershipIdentityParts } from \"./EncryptionManager.ts\";\nimport { isLeftMembershipContent } from \"./membershipData/index.ts\";\nimport { isSlotOpen, slotIdToDescription } from \"./utils.ts\";\n\nexport type EncryptionKeyMapKey = string;\n\nexport interface EncryptionKeyEntry {\n    index: number;\n    key: string;\n}\n\n/**\n * The mxID, deviceId and membership timestamp of a RTC session participant.\n */\nexport type ParticipantDeviceInfo = {\n    userId: string;\n    deviceId: string;\n    membershipTs: number;\n};\n\n/**\n * A type representing the information needed to decrypt video streams.\n */\nexport type InboundEncryptionSession = {\n    key: Uint8Array<ArrayBuffer>;\n    membership: CallMembershipIdentityParts;\n    keyIndex: number;\n    creationTS: number;\n};\n\n/**\n * The information about the key used to encrypt video streams.\n */\nexport type OutboundEncryptionSession = {\n    key: Uint8Array<ArrayBuffer>;\n    creationTS: number;\n    // The devices that this key is shared with.\n    sharedWith: Array<ParticipantDeviceInfo>;\n    // This is an index acting as the id of the key\n    keyId: number;\n};\n\nexport interface EncryptionKeysEventContent {\n    keys: EncryptionKeyEntry[];\n    device_id: string;\n    call_id: string;\n    sent_ts?: number;\n}\n\n/**\n * THe content of a to-device event that contains encryption keys.\n */\nexport interface EncryptionKeysToDeviceEventContent {\n    keys: { index: number; key: string };\n    member: {\n        id: string;\n        // TODO Remove that it is claimed, need to get the sealed sender from decryption info\n        // Or add some validation on it based on the encryption info\n        claimed_device_id: string;\n    };\n    room_id: string;\n    session: {\n        application: string;\n        call_id: string;\n        scope: string;\n    };\n    // Why is this needed?\n    sent_ts?: number;\n}\n/**\n * @deprecated Use `RTCNotificationType` instead.\n */\nexport type CallNotifyType = \"ring\" | \"notify\";\n/**\n * @deprecated Use `IRTCNotificationContent` instead.\n */\nexport interface ICallNotifyContent {\n    \"application\": string;\n    \"m.mentions\": IMentions;\n    \"notify_type\": CallNotifyType;\n    \"call_id\": string;\n}\n\nexport type RTCNotificationType = \"ring\" | \"notification\";\n\n/**\n * Represents the intention of the call from the perspective of the sending user.\n * May be any string, although `\"audio\"` and `\"video\"` are commonly accepted values.\n */\nexport type RTCCallIntent = \"audio\" | \"video\" | string;\n\n/**\n * The maximum `lifetime` of an RTC notification as per MSC4075. Larger values are capped to this.\n *\n * Exported for use within the js-sdk only. Not re-exported from `matrixrtc/index.ts`.\n * @internal\n */\nexport const RTC_NOTIFICATION_MAX_LIFETIME_MS = 2 * 60 * 1000; // 2 minutes\n\n/**\n * The maximum amount by which a notification's `sender_ts` may lie ahead of its `origin_server_ts`\n * before the `lifetime` is measured from `origin_server_ts` instead, as per MSC4075.\n *\n * Exported for use within the js-sdk only. Not re-exported from `matrixrtc/index.ts`.\n * @internal\n */\nexport const RTC_NOTIFICATION_MAX_SENDER_TS_AHEAD_MS = 20 * 1000; // 20 seconds\n\n/**\n * The context that is needed to evaluate the MSC4075 rules for receiving notifications.\n */\nexport interface RTCNotificationValidationContext {\n    /** The room in which the notification was received. */\n    room: Pick<\n        Room,\n        \"getLiveTimeline\" | \"getUnfilteredTimelineSet\" | \"_unstable_getStickyEvents\" | \"_unstable_getKeyedStickyEvent\"\n    >;\n    /** The user ID of the receiving (local) user. */\n    userId: string;\n    /** The current time in milliseconds since the epoch. Defaults to `Date.now()`. */\n    now?: number;\n}\n\n/**\n * Computes the absolute timestamp at which an RTC notification stops being valid, as per MSC4075.\n *\n * The `lifetime` is measured from `sender_ts` unless `sender_ts` lies more than 20 seconds ahead of\n * `origin_server_ts`, in which case it is measured from `origin_server_ts` instead. Regardless of the basis,\n * the remaining lifetime is capped at 2 minutes.\n *\n * @param content The notification content.\n * @param originServerTs The `origin_server_ts` of the notification event.\n * @param now The current time in milliseconds since the epoch. Defaults to `Date.now()`.\n * @returns The timestamp (in milliseconds since the epoch) at which the notification expires.\n */\nexport function getCallNotificationExpiry(\n    content: Pick<IRTCNotificationContent, \"sender_ts\" | \"lifetime\">,\n    originServerTs: number,\n    now: number = Date.now(),\n): number {\n    const basis =\n        content.sender_ts - originServerTs > RTC_NOTIFICATION_MAX_SENDER_TS_AHEAD_MS\n            ? originServerTs\n            : content.sender_ts;\n    return Math.min(basis + content.lifetime, now + RTC_NOTIFICATION_MAX_LIFETIME_MS);\n}\n\n/**\n * The subset of a notification event that {@link parseCallNotificationContent} needs.\n */\ntype RTCNotificationEvent = Pick<\n    MatrixEvent,\n    \"getContent\" | \"getId\" | \"getSender\" | \"getTs\" | \"getType\" | \"unstableStickyInfo\"\n>;\n\n/**\n * Whether the content marks a withdrawn sticky event (MSC4354), i.e. it is empty apart from the sticky key.\n */\nfunction isWithdrawal(content: IContent): boolean {\n    return Object.keys(content).every((key) => key === \"msc4354_sticky_key\");\n}\n\nfunction isNonNegativeInteger(value: unknown): value is number {\n    return Number.isInteger(value) && (value as number) >= 0;\n}\n\n/**\n * Looks up a legacy `m.call.member` state event by ID in the room's current state.\n *\n * @returns The event, or `undefined` if no current membership state event has that ID.\n */\nfunction findMembershipStateEvent(\n    room: RTCNotificationValidationContext[\"room\"],\n    eventId: string,\n): MatrixEvent | undefined {\n    const roomState = room.getLiveTimeline().getState(EventTimeline.FORWARDS);\n    return roomState?.getStateEvents(EventType.GroupCallMemberPrefix).find((event) => event.getId() === eventId);\n}\n\n/**\n * Determines the ID of the slot that a notification invites to.\n *\n * Notifications predating the `slot_id` property instead carry an `m.reference` relation to the sender's\n * membership event.\n *\n * @throws if the slot can't be determined.\n * @returns A promise resolving to the slot ID.\n */\nasync function resolveSlotId(content: IContent, room: RTCNotificationValidationContext[\"room\"]): Promise<string> {\n    if (typeof content[\"slot_id\"] === \"string\") {\n        // Throws if the ID is malformed, e.g. because it contains more than one \"#\".\n        slotIdToDescription(content[\"slot_id\"]);\n        return content[\"slot_id\"];\n    }\n    if (content[\"slot_id\"] !== undefined) throw new Error(\"Invalid slot_id\");\n\n    const relation = content[\"m.relates_to\"];\n    const membershipEventId = relation?.rel_type === RelationType.Reference ? relation.event_id : undefined;\n    if (typeof membershipEventId !== \"string\") {\n        throw new Error(\"Missing slot_id and no m.reference relation to derive it from\");\n    }\n\n    const membershipEvent = findMembershipStateEvent(room, membershipEventId);\n    if (!membershipEvent) {\n        throw new Error(`Missing slot_id and referenced event ${membershipEventId} is not a current membership`);\n    }\n\n    try {\n        return (await CallMembership.parseFromEvent(membershipEvent)).slotId;\n    } catch (cause) {\n        throw new Error(`Missing slot_id and referenced event ${membershipEventId} is not a valid membership`, {\n            cause,\n        });\n    }\n}\n\n/**\n * Parses the content of a received `org.matrix.msc4075.rtc.notification` event.\n *\n * This checks that the content matches the schema of MSC4075, caps `lifetime` to 2 minutes and applies\n * the rules for receiving invites from MSC4075.\n * The notification is only considered valid if all of the following hold:\n * - It wasn't sent by the receiving user.\n * - It is the current entry in the room's sticky event map for its sender and slot and isn't a withdrawal.\n * - The slot it refers to exists and is open.\n * - Its lifetime hasn't elapsed (see {@link getCallNotificationExpiry}).\n * - Its `m.mentions` target the receiving user, either directly or via a room mention that the sender is\n *   allowed to trigger.\n * - The receiving user has no joined `m.rtc.member` event for the slot in the sticky event map.\n * - Any left `m.rtc.member` event of the receiving user for the slot predates the notification.\n * - The receiving user has no sticky decline event referencing the notification.\n *\n * @param event The notification event.\n * @param context The context needed to evaluate the receiving rules.\n * @throws if the content is malformed or the notification isn't valid.\n * @returns A promise resolving to the parsed content.\n */\nexport async function parseCallNotificationContent(\n    event: RTCNotificationEvent,\n    context: RTCNotificationValidationContext,\n): Promise<IRTCNotificationContent> {\n    if (event.getType() !== EventType.RTCNotification) {\n        throw new Error(`Event ${event.getId()} is not an ${EventType.RTCNotification} event`);\n    }\n\n    const content = event.getContent();\n    if (isWithdrawal(content)) {\n        throw new Error(\"Notification was withdrawn\");\n    }\n\n    const slotId = await resolveSlotId(content, context.room);\n    // The sticky key is only validated when present. A notification predating it can still be valid, and one\n    // carrying the wrong key is filed under that key in the sticky event map, so the lookup below rejects it.\n    if (content[\"msc4354_sticky_key\"] !== undefined && content[\"msc4354_sticky_key\"] !== slotId) {\n        throw new Error(\"msc4354_sticky_key must be equal to slot_id\");\n    }\n    if (!isNonNegativeInteger(content[\"sender_ts\"])) {\n        throw new Error(\"Missing or invalid sender_ts\");\n    }\n    if (!isNonNegativeInteger(content[\"lifetime\"])) {\n        throw new Error(\"Missing or invalid lifetime\");\n    }\n\n    const mentions = content[\"m.mentions\"];\n    if (typeof mentions !== \"object\" || mentions === null) {\n        throw new Error(\"Missing or malformed m.mentions\");\n    }\n    if (mentions.room !== undefined && typeof mentions.room !== \"boolean\") {\n        throw new Error(\"malformed m.mentions.room\");\n    }\n    if (\n        mentions.user_ids !== undefined &&\n        (!Array.isArray(mentions.user_ids) || !mentions.user_ids.every((userId) => typeof userId === \"string\"))\n    ) {\n        throw new Error(\"malformed m.mentions.user_ids\");\n    }\n    if (mentions.room !== true && !mentions.user_ids?.length) {\n        throw new Error(\"m.mentions must target either the room or at least one user\");\n    }\n\n    const parsed = {\n        ...content,\n        slot_id: slotId,\n        lifetime: Math.min(content[\"lifetime\"], RTC_NOTIFICATION_MAX_LIFETIME_MS),\n    } as IRTCNotificationContent;\n\n    await checkCallNotificationReceivingRules(parsed, event, context);\n\n    return parsed;\n}\n\n/**\n * Applies the MSC4075 rules for receiving invites to an already schema-validated notification.\n * @throws if any of the rules is violated.\n */\nasync function checkCallNotificationReceivingRules(\n    content: IRTCNotificationContent,\n    event: RTCNotificationEvent,\n    { room, userId, now = Date.now() }: RTCNotificationValidationContext,\n): Promise<void> {\n    const eventId = event.getId();\n    const sender = event.getSender();\n    if (eventId === undefined || sender === undefined) {\n        throw new Error(\"Notification event is missing its event ID or sender\");\n    }\n    const originServerTs = event.getTs();\n    const slotId = content.slot_id;\n\n    if (sender === userId) {\n        throw new Error(\"Notification was sent by the receiving user\");\n    }\n\n    // A notification that wasn't delivered as a sticky event can't be superseded or withdrawn, so there is\n    // nothing to check. It isn't in the sticky event map either, which is why this can't be checked blindly.\n    if (event.unstableStickyInfo !== undefined) {\n        if (room._unstable_getKeyedStickyEvent(sender, event.getType(), slotId)?.getId() !== eventId) {\n            throw new Error(\"Notification is not the current sticky event for its sender and slot\");\n        }\n    }\n\n    // `isSlotOpen` returns undefined when no slot event exists at all, which is just as disqualifying.\n    if (!isSlotOpen(room, slotIdToDescription(slotId))) {\n        throw new Error(`Slot ${slotId} does not exist or is closed`);\n    }\n    const roomState = room.getLiveTimeline().getState(EventTimeline.FORWARDS);\n\n    if (now >= getCallNotificationExpiry(content, originServerTs, now)) {\n        throw new Error(\"Notification has expired\");\n    }\n\n    const mentions = content[\"m.mentions\"];\n    const mentionsUser = mentions.user_ids?.includes(userId) ?? false;\n    const mentionsRoom = mentions.room === true && (roomState?.mayTriggerNotifOfType(\"room\", sender) ?? false);\n    if (!mentionsUser && !mentionsRoom) {\n        throw new Error(\"Notification does not mention the receiving user\");\n    }\n\n    for (const membershipEvent of ownMembershipEvents(room, userId)) {\n        const membershipContent = membershipEvent.getContent();\n        if (isLeftMembershipContent(membershipContent)) {\n            if (membershipContent.slot_id === slotId && membershipEvent.getTs() >= originServerTs) {\n                throw new Error(`Receiving user left slot ${slotId} after the notification was sent`);\n            }\n        } else if (await isJoinedToSlot(membershipEvent, slotId, now)) {\n            throw new Error(`Receiving user is already joined to slot ${slotId}`);\n        }\n    }\n\n    if (hasDeclined(room, userId, eventId)) {\n        throw new Error(\"Receiving user declined the notification\");\n    }\n}\n\n/**\n * Yields the receiving user's own MatrixRTC membership events, from both the sticky event map and the legacy\n * member state events. Sessions that don't use sticky events keep membership in state, so both have to be\n * consulted to tell whether the user is in a session.\n *\n * @yields the user's own `m.rtc.member` and `m.call.member` events.\n */\nfunction* ownMembershipEvents(room: RTCNotificationValidationContext[\"room\"], userId: string): Iterable<MatrixEvent> {\n    for (const stickyEvent of room._unstable_getStickyEvents()) {\n        if (stickyEvent.getType() === EventType.RTCMembership && stickyEvent.getSender() === userId) {\n            yield stickyEvent;\n        }\n    }\n\n    const roomState = room.getLiveTimeline().getState(EventTimeline.FORWARDS);\n    for (const stateEvent of roomState?.getStateEvents(EventType.GroupCallMemberPrefix) ?? []) {\n        if (stateEvent.getSender() === userId) yield stateEvent;\n    }\n}\n\n/**\n * Whether the given membership event places its sender in the given slot, i.e. it is a valid, unexpired\n * membership for that slot.\n */\nasync function isJoinedToSlot(membershipEvent: MatrixEvent, slotId: string, now: number): Promise<boolean> {\n    let membership: CallMembership;\n    try {\n        membership = await CallMembership.parseFromEvent(membershipEvent);\n    } catch {\n        // Not a membership we understand, so it doesn't place the user anywhere.\n        return false;\n    }\n    if (membership.slotId !== slotId) return false;\n\n    // Legacy memberships go stale when the client that sent them disappears without leaving. Honouring an\n    // expired one would suppress notifications for hours.\n    const expiry = membership.getAbsoluteExpiry();\n    return expiry === undefined || expiry > now;\n}\n\n/**\n * Whether the receiving user has declined the given notification.\n *\n * Declines are looked up both through their `m.reference` relation and in the sticky event map. Relations\n * cover declines that couldn't be sent as sticky events, but only see events that reached the timeline. A\n * sticky decline delivered after a gappy or initial sync arrives via the sticky section instead, so it is\n * only in the map.\n */\nfunction hasDeclined(room: RTCNotificationValidationContext[\"room\"], userId: string, eventId: string): boolean {\n    const declines = room\n        .getUnfilteredTimelineSet()\n        .relations.getChildEventsForEvent(eventId, RelationType.Reference, EventType.RTCDecline);\n    if (declines?.getRelations().some((decline) => decline.getSender() === userId)) return true;\n\n    // Declines are keyed on the event ID of the notification they decline.\n    return room._unstable_getKeyedStickyEvent(userId, EventType.RTCDecline, eventId) !== undefined;\n}\n\n/**\n * Interface for `org.matrix.msc4075.rtc.notification` events.\n * Don't cast event content to this directly. Use `parseCallNotificationContent` instead to validate the content first.\n */\nexport interface IRTCNotificationContent extends RelationEvent {\n    /**\n     * The `state_key` of the `m.rtc.slot` event that the notification refers to.\n     *\n     * Notifications predating this property omit it. `parseCallNotificationContent` fills it in from the\n     * referenced membership event, so the parsed content always carries it.\n     */\n    \"slot_id\": string;\n    /**\n     * The users targeted by the notification. Must either mention the room or at least one user.\n     */\n    \"m.mentions\": IMentions;\n    /**\n     * @deprecated Not part of MSC4075 anymore. How to present a notification is up to the receiving client.\n     */\n    \"notification_type\"?: RTCNotificationType;\n    /**\n     * @deprecated Not part of MSC4075 anymore. The initial intent of the calling user.\n     */\n    \"m.call.intent\"?: RTCCallIntent;\n    /**\n     * The timestamp (in milliseconds since the epoch) at which the sending client created the event.\n     */\n    \"sender_ts\": number;\n    /**\n     * The time (in milliseconds) that the notification is valid for, measured from `sender_ts`.\n     */\n    \"lifetime\": number;\n    /**\n     * The sticky key as per MSC4354. Must be equal to `slot_id`.\n     *\n     * Optional because notifications predating MSC4354 omit it.\n     */\n    \"msc4354_sticky_key\"?: string;\n}\n\n/**\n * MSC4310 decline event content for `org.matrix.msc4310.rtc.decline`.\n * Sent as a standard m.reference relation to an `org.matrix.msc4075.rtc.notification` event.\n */\nexport interface IRTCDeclineContent extends RelationEvent {\n    /**\n     * The sticky key as per MSC4354. Must be equal to the event ID of the notification being declined.\n     *\n     * Optional because servers without MSC4354 support can't deliver the decline as a sticky event. Such a\n     * decline still counts, but only for devices that receive it directly, since it isn't re-delivered after\n     * a gappy or initial sync.\n     */\n    msc4354_sticky_key?: string;\n}\n\nexport enum Status {\n    Disconnected = \"Disconnected\",\n    Connecting = \"Connecting\",\n    Connected = \"Connected\",\n    Disconnecting = \"Disconnecting\",\n    Unknown = \"Unknown\",\n}\n\n/**\n * A type collecting call encryption statistics for a session.\n */\nexport type Statistics = {\n    counters: {\n        /**\n         * The number of times we have sent a room event containing encryption keys.\n         */\n        roomEventEncryptionKeysSent: number;\n        /**\n         * The number of times we have received a room event containing encryption keys.\n         */\n        roomEventEncryptionKeysReceived: number;\n    };\n    totals: {\n        /**\n         * The total age (in milliseconds) of all room events containing encryption keys that we have received.\n         * We track the total age so that we can later calculate the average age of all keys received.\n         */\n        roomEventEncryptionKeysReceivedTotalAge: number;\n    };\n};\n\nexport const isMyMembership = (m: CallMembership, userId: string, deviceId: string): boolean =>\n    m.sender === userId && m.deviceId === deviceId;\n\n/**\n *  A RTC transport is a JSON object that describes how to connect to a RTC member.\n */\nexport interface Transport {\n    type: string;\n    [key: string]: unknown;\n}\n\n/**\n * Event content for `org.matrix.msc4143.rtc.slot` state events.\n */\nexport interface RtcSlotEventContent<T extends string = string> {\n    status: \"open\" | \"closed\";\n    application?: RtcSlotApplicationContent<T>;\n    encryption?: RtcSlotEncryptionContent;\n}\n\n/**\n * Content of the `application` object within `org.matrix.msc4143.rtc.slot` events.\n */\nexport interface RtcSlotApplicationContent<T extends string = string> {\n    type: T;\n    // Other application specific keys.\n    [key: string]: unknown;\n}\n\nexport const RTC_SLOT_ENCRYPTION_PER_MEMBER = \"org.matrix.msc4143.per_member\";\n\n/**\n * Content of the `encryption` object within `org.matrix.msc4143.rtc.slot` events.\n */\nexport interface RtcSlotEncryptionContent {\n    type: typeof RTC_SLOT_ENCRYPTION_PER_MEMBER;\n    // Other encryption-mechanism specific keys.\n    [key: string]: unknown;\n}\n\n/**\n * The session description is used to identify a session. Used in the state event.\n */\nexport interface SlotDescription {\n    /**\n     * The application type. e.g. \"m.call\".\n     */\n    application: string;\n    /**\n     * The application-specific slot ID. e.g. \"ROOM\".\n     */\n    id: string;\n}\n"],"mappings":";AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;;AAKA,SAAS,aAAa,QAAQ,6BAA6B;AAC3D,SAAS,SAAS,EAAE,YAAY,QAAQ,oBAAoB;AAC5D,SAAS,cAAc,QAAQ,qBAAqB;AAEpD,SAAS,uBAAuB,QAAQ,2BAA2B;AACnE,SAAS,UAAU,EAAE,mBAAmB,QAAQ,YAAY;;AAS5D;AACA;AACA;;AAOA;AACA;AACA;;AAQA;AACA;AACA;;AAiBA;AACA;AACA;;AAkBA;AACA;AACA;;AAEA;AACA;AACA;;AAUA;AACA;AACA;AACA;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM,gCAAgC,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;;AAE/D;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAM,uCAAuC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;;AAElE;AACA;AACA;;AAaA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,SAAS,yBAAyB,CACrC,OAAgE,EAChE,cAAsB,EACtB,GAAW,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAClB;EACN,MAAM,KAAK,GACP,OAAO,CAAC,SAAS,GAAG,cAAc,GAAG,uCAAuC,GACtE,cAAc,GACd,OAAO,CAAC,SAAS;EAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,GAAG,OAAO,CAAC,QAAQ,EAAE,GAAG,GAAG,gCAAgC,CAAC;AACrF;;AAEA;AACA;AACA;;AAMA;AACA;AACA;AACA,SAAS,YAAY,CAAC,OAAiB,EAAW;EAC9C,OAAO,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,KAAK,CAAE,GAAG,IAAK,GAAG,KAAK,oBAAoB,CAAC;AAC5E;AAEA,SAAS,oBAAoB,CAAC,KAAc,EAAmB;EAC3D,OAAO,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,IAAK,KAAK,IAAe,CAAC;AAC5D;;AAEA;AACA;AACA;AACA;AACA;AACA,SAAS,wBAAwB,CAC7B,IAA8C,EAC9C,OAAe,EACQ;EACvB,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC;EACzE,OAAO,SAAS,EAAE,cAAc,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAE,KAAK,IAAK,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,OAAO,CAAC;AAChH;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,eAAe,aAAa,CAAC,OAAiB,EAAE,IAA8C,EAAmB;EAC7G,IAAI,OAAO,OAAO,CAAC,SAAS,CAAC,KAAK,QAAQ,EAAE;IACxC;IACA,mBAAmB,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,OAAO,CAAC,SAAS,CAAC;EAC7B;EACA,IAAI,OAAO,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC;EAExE,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC;EACxC,MAAM,iBAAiB,GAAG,QAAQ,EAAE,QAAQ,KAAK,YAAY,CAAC,SAAS,GAAG,QAAQ,CAAC,QAAQ,GAAG,SAAS;EACvG,IAAI,OAAO,iBAAiB,KAAK,QAAQ,EAAE;IACvC,MAAM,IAAI,KAAK,CAAC,+DAA+D,CAAC;EACpF;EAEA,MAAM,eAAe,GAAG,wBAAwB,CAAC,IAAI,EAAE,iBAAiB,CAAC;EACzE,IAAI,CAAC,eAAe,EAAE;IAClB,MAAM,IAAI,KAAK,CAAC,wCAAwC,iBAAiB,8BAA8B,CAAC;EAC5G;EAEA,IAAI;IACA,OAAO,CAAC,MAAM,cAAc,CAAC,cAAc,CAAC,eAAe,CAAC,EAAE,MAAM;EACxE,CAAC,CAAC,OAAO,KAAK,EAAE;IACZ,MAAM,IAAI,KAAK,CAAC,wCAAwC,iBAAiB,4BAA4B,EAAE;MACnG;IACJ,CAAC,CAAC;EACN;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,eAAe,4BAA4B,CAC9C,KAA2B,EAC3B,OAAyC,EACT;EAChC,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,KAAK,SAAS,CAAC,eAAe,EAAE;IAC/C,MAAM,IAAI,KAAK,CAAC,SAAS,KAAK,CAAC,KAAK,CAAC,CAAC,cAAc,SAAS,CAAC,eAAe,QAAQ,CAAC;EAC1F;EAEA,MAAM,OAAO,GAAG,KAAK,CAAC,UAAU,CAAC,CAAC;EAClC,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE;IACvB,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC;EACjD;EAEA,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC;EACzD;EACA;EACA,IAAI,OAAO,CAAC,oBAAoB,CAAC,KAAK,SAAS,IAAI,OAAO,CAAC,oBAAoB,CAAC,KAAK,MAAM,EAAE;IACzF,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC;EAClE;EACA,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,EAAE;IAC7C,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC;EACnD;EACA,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,EAAE;IAC5C,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC;EAClD;EAEA,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;EACtC,IAAI,OAAO,QAAQ,KAAK,QAAQ,IAAI,QAAQ,KAAK,IAAI,EAAE;IACnD,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC;EACtD;EACA,IAAI,QAAQ,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE;IACnE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC;EAChD;EACA,IACI,QAAQ,CAAC,QAAQ,KAAK,SAAS,KAC9B,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAE,MAAM,IAAK,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,EACzG;IACE,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC;EACpD;EACA,IAAI,QAAQ,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE;IACtD,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC;EAClF;EAEA,MAAM,MAAM,mCACL,OAAO;IACV,OAAO,EAAE,MAAM;IACf,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,gCAAgC;EAAC,EACjD;EAE5B,MAAM,mCAAmC,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC;EAEjE,OAAO,MAAM;AACjB;;AAEA;AACA;AACA;AACA;AACA,eAAe,mCAAmC,CAC9C,OAAgC,EAChC,KAA2B,EAC3B;EAAE,IAAI;EAAE,MAAM;EAAE,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC;AAAoC,CAAC,EACvD;EACb,MAAM,OAAO,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;EAC7B,MAAM,MAAM,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC;EAChC,IAAI,OAAO,KAAK,SAAS,IAAI,MAAM,KAAK,SAAS,EAAE;IAC/C,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC;EAC3E;EACA,MAAM,cAAc,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC;EACpC,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO;EAE9B,IAAI,MAAM,KAAK,MAAM,EAAE;IACnB,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC;EAClE;;EAEA;EACA;EACA,IAAI,KAAK,CAAC,kBAAkB,KAAK,SAAS,EAAE;IACxC,IAAI,IAAI,CAAC,6BAA6B,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,CAAC,CAAC,KAAK,OAAO,EAAE;MAC1F,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC;IAC3F;EACJ;;EAEA;EACA,IAAI,CAAC,UAAU,CAAC,IAAI,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC,EAAE;IAChD,MAAM,IAAI,KAAK,CAAC,QAAQ,MAAM,8BAA8B,CAAC;EACjE;EACA,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC;EAEzE,IAAI,GAAG,IAAI,yBAAyB,CAAC,OAAO,EAAE,cAAc,EAAE,GAAG,CAAC,EAAE;IAChE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC;EAC/C;EAEA,MAAM,QAAQ,GAAG,OAAO,CAAC,YAAY,CAAC;EACtC,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK;EACjE,MAAM,YAAY,GAAG,QAAQ,CAAC,IAAI,KAAK,IAAI,KAAK,SAAS,EAAE,qBAAqB,CAAC,MAAM,EAAE,MAAM,CAAC,IAAI,KAAK,CAAC;EAC1G,IAAI,CAAC,YAAY,IAAI,CAAC,YAAY,EAAE;IAChC,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC;EACvE;EAEA,KAAK,MAAM,eAAe,IAAI,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE;IAC7D,MAAM,iBAAiB,GAAG,eAAe,CAAC,UAAU,CAAC,CAAC;IACtD,IAAI,uBAAuB,CAAC,iBAAiB,CAAC,EAAE;MAC5C,IAAI,iBAAiB,CAAC,OAAO,KAAK,MAAM,IAAI,eAAe,CAAC,KAAK,CAAC,CAAC,IAAI,cAAc,EAAE;QACnF,MAAM,IAAI,KAAK,CAAC,4BAA4B,MAAM,kCAAkC,CAAC;MACzF;IACJ,CAAC,MAAM,IAAI,MAAM,cAAc,CAAC,eAAe,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE;MAC3D,MAAM,IAAI,KAAK,CAAC,4CAA4C,MAAM,EAAE,CAAC;IACzE;EACJ;EAEA,IAAI,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;IACpC,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC;EAC/D;AACJ;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,UAAU,mBAAmB,CAAC,IAA8C,EAAE,MAAc,EAAyB;EACjH,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,yBAAyB,CAAC,CAAC,EAAE;IACxD,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC,KAAK,SAAS,CAAC,aAAa,IAAI,WAAW,CAAC,SAAS,CAAC,CAAC,KAAK,MAAM,EAAE;MACzF,MAAM,WAAW;IACrB;EACJ;EAEA,MAAM,SAAS,GAAG,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,QAAQ,CAAC;EACzE,KAAK,MAAM,UAAU,IAAI,SAAS,EAAE,cAAc,CAAC,SAAS,CAAC,qBAAqB,CAAC,IAAI,EAAE,EAAE;IACvF,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC,KAAK,MAAM,EAAE,MAAM,UAAU;EAC3D;AACJ;;AAEA;AACA;AACA;AACA;AACA,eAAe,cAAc,CAAC,eAA4B,EAAE,MAAc,EAAE,GAAW,EAAoB;EACvG,IAAI,UAA0B;EAC9B,IAAI;IACA,UAAU,GAAG,MAAM,cAAc,CAAC,cAAc,CAAC,eAAe,CAAC;EACrE,CAAC,CAAC,MAAM;IACJ;IACA,OAAO,KAAK;EAChB;EACA,IAAI,UAAU,CAAC,MAAM,KAAK,MAAM,EAAE,OAAO,KAAK;;EAE9C;EACA;EACA,MAAM,MAAM,GAAG,UAAU,CAAC,iBAAiB,CAAC,CAAC;EAC7C,OAAO,MAAM,KAAK,SAAS,IAAI,MAAM,GAAG,GAAG;AAC/C;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,SAAS,WAAW,CAAC,IAA8C,EAAE,MAAc,EAAE,OAAe,EAAW;EAC3G,MAAM,QAAQ,GAAG,IAAI,CAChB,wBAAwB,CAAC,CAAC,CAC1B,SAAS,CAAC,sBAAsB,CAAC,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC;EAC5F,IAAI,QAAQ,EAAE,YAAY,CAAC,CAAC,CAAC,IAAI,CAAE,OAAO,IAAK,OAAO,CAAC,SAAS,CAAC,CAAC,KAAK,MAAM,CAAC,EAAE,OAAO,IAAI;;EAE3F;EACA,OAAO,IAAI,CAAC,6BAA6B,CAAC,MAAM,EAAE,SAAS,CAAC,UAAU,EAAE,OAAO,CAAC,KAAK,SAAS;AAClG;;AAEA;AACA;AACA;AACA;;AAqCA;AACA;AACA;AACA;;AAYA,WAAY,MAAM,0BAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAN,MAAM;EAAA,OAAN,MAAM;AAAA;;AAQlB;AACA;AACA;;AAqBA,OAAO,MAAM,cAAc,GAAG,CAAC,CAAiB,EAAE,MAAc,EAAE,QAAgB,KAC9E,CAAC,CAAC,MAAM,KAAK,MAAM,IAAI,CAAC,CAAC,QAAQ,KAAK,QAAQ;;AAElD;AACA;AACA;;AAMA;AACA;AACA;;AAOA;AACA;AACA;;AAOA,OAAO,MAAM,8BAA8B,GAAG,+BAA+B;;AAE7E;AACA;AACA;;AAOA;AACA;AACA","ignoreList":[]}

package/lib/matrixrtc/utils.d.ts

@@ -1,5 +1,6 @@
 import { type CallMembershipIdentityParts } from "./EncryptionManager.ts";
-import type { InboundEncryptionSession, SlotDescription } from "./types.ts";
+import type { InboundEncryptionSession, RtcSlotEventContent, SlotDescription } from "./types.ts";
+import type { Room } from "../models/room.ts";
 /**
  * Detects when a key for a given index is outdated.
  */
@@ -23,4 +24,24 @@ export declare function slotIdToDescription(slotId: string): SlotDescription;
  * Converts a SlotDescription into it's slot ID format.
  */
 export declare function computeSlotId(slotDescription: SlotDescription): string;
+/**
+ * Reads the slot state event's content for the given slot description.
+ *
+ * @returns The slot event's content, or `undefined` if no slot event exists for the given description.
+ */
+export declare function getSlotEventContent(room: Pick<Room, "getLiveTimeline">, slotDescription: SlotDescription): RtcSlotEventContent | undefined;
+/**
+ * Whether the given slot is closed.
+ *
+ * @returns `true` if the slot is closed, `false` if the slot is open or `undefined`
+ * if no slot exists.
+ */
+export declare function isSlotClosed(room: Pick<Room, "getLiveTimeline">, slotDescription: SlotDescription): boolean | undefined;
+/**
+ * Whether the given slot is open.
+ *
+ * @returns `true` if the slot is open, `false` if the slot is closed or `undefined`
+ * if no slot exists.
+ */
+export declare function isSlotOpen(room: Pick<Room, "getLiveTimeline">, slotDescription: SlotDescription): boolean | undefined;
 //# sourceMappingURL=utils.d.ts.map

package/lib/matrixrtc/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/matrixrtc/utils.ts"],"names":[],"mappings":"AAgBA,OAAO,EAA0B,KAAK,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAClG,OAAO,KAAK,EAAE,wBAAwB,EAAuB,eAAe,EAAE,MAAM,YAAY,CAAC;AAEjG;;GAEG;AACH,qBAAa,iBAAiB;IAE1B,OAAO,CAAC,QAAQ,CAA4D;IAE5E;;;;;OAKG;IACI,UAAU,CAAC,UAAU,EAAE,2BAA2B,EAAE,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAalG;CACJ;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAQnE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAEtE"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/matrixrtc/utils.ts"],"names":[],"mappings":"AAgBA,OAAO,EAA0B,KAAK,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAClG,OAAO,KAAK,EAAE,wBAAwB,EAAuB,mBAAmB,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AACtH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAI9C;;GAEG;AACH,qBAAa,iBAAiB;IAE1B,OAAO,CAAC,QAAQ,CAA4D;IAE5E;;;;;OAKG;IACI,UAAU,CAAC,UAAU,EAAE,2BAA2B,EAAE,IAAI,EAAE,wBAAwB,GAAG,OAAO,CAalG;CACJ;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,MAAM,GAAG,eAAe,CAQnE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,eAAe,EAAE,eAAe,GAAG,MAAM,CAEtE;AAED;;;;GAIG;AACH,wBAAgB,mBAAmB,CAC/B,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,EACnC,eAAe,EAAE,eAAe,GACjC,mBAAmB,GAAG,SAAS,CASjC;AAED;;;;;GAKG;AACH,wBAAgB,YAAY,CACxB,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,EACnC,eAAe,EAAE,eAAe,GACjC,OAAO,GAAG,SAAS,CASrB;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,iBAAiB,CAAC,EAAE,eAAe,EAAE,eAAe,GAAG,OAAO,GAAG,SAAS,CAGrH"}