matrix-js-sdk 41.0.0 → 41.1.0

package/lib/matrixrtc/CallMembership.d.ts

@@ -1,166 +1,67 @@
-import { type LivekitFocusSelection } from "./LivekitTransport.ts";
-import { type SlotDescription } from "./MatrixRTCSession.ts";
-import type { RTCCallIntent, Transport } from "./types.ts";
+import { type RTCCallIntent, type Transport, type SlotDescription } from "./types.ts";
 import { type MatrixEvent } from "../models/event.ts";
-import { type RelationType } from "../@types/event.ts";
-import { type Logger } from "../logger.ts";
+import { type RtcMembershipData, type SessionMembershipData } from "./membershipData/index.ts";
 /**
  * The default duration in milliseconds that a membership is considered valid for.
  * Ordinarily the client responsible for the session will update the membership before it expires.
  * We use this duration as the fallback case where stale sessions are present for some reason.
  */
 export declare const DEFAULT_EXPIRE_DURATION: number;
-type CallScope = "m.room" | "m.user";
-type Member = {
-    user_id: string;
-    device_id: string;
-    /**
-     * The id used on the media backend.
-     * (With livekit this is the participant identity on the LK SFU)
-     * This can be a UUID but right now it is `${this.matrixEventData.sender}:${data.device_id}`.
-     */
-    id: string;
-};
-export interface RtcMembershipData {
-    "slot_id": string;
-    "member": Member;
-    "m.relates_to"?: {
-        event_id: string;
-        rel_type: RelationType.Reference;
-    };
-    "application": {
-        type: string;
-        [key: string]: unknown;
-    };
-    "rtc_transports": Transport[];
-    "versions": string[];
-    "msc4354_sticky_key"?: string;
-    "sticky_key"?: string;
-}
 /**
- * MSC4143 (MatrixRTC) session membership data.
- * Represents the `session` in the memberships section of an m.call.member event as it is on the wire.
- **/
-export type SessionMembershipData = {
-    /**
-     * The RTC application defines the type of the RTC session.
-     */
-    "application": string;
-    /**
-     * The id of this session.
-     * A session can never span over multiple rooms so this id is to distinguish between
-     * multiple session in one room. A room wide session that is not associated with a user,
-     * and therefore immune to creation race conflicts, uses the `call_id: ""`.
-     */
-    "call_id": string;
-    /**
-     * The Matrix device ID of this session. A single user can have multiple sessions on different devices.
-     */
-    "device_id": string;
-    /**
-     * The focus selection system this user/membership is using.
-     */
-    "focus_active": LivekitFocusSelection;
-    /**
-     * A list of possible foci this user knows about. One of them might be used based on the focus_active
-     * selection system.
-     */
-    "foci_preferred": Transport[];
-    /**
-     * Optional field that contains the creation of the session. If it is undefined the creation
-     * is the `origin_server_ts` of the event itself. For updates to the event this property tracks
-     * the `origin_server_ts` of the initial join event.
-     *  - If it is undefined it can be interpreted as a "Join".
-     *  - If it is defined it can be interpreted as an "Update"
-     */
-    "created_ts"?: number;
-    /**
-     * If the `application` = `"m.call"` this defines if it is a room or user owned call.
-     * There can always be one room scoped call but multiple user owned calls (breakout sessions)
-     */
-    "scope"?: CallScope;
-    /**
-     * Optionally we allow to define a delta to the `created_ts` that defines when the event is expired/invalid.
-     * This should be set to multiple hours. The only reason it exist is to deal with failed delayed events.
-     * (for example caused by a homeserver crashes)
-     **/
-    "expires"?: number;
-    /**
-     * The intent of the call from the perspective of this user. This may be an audio call, video call or
-     * something else.
-     */
-    "m.call.intent"?: RTCCallIntent;
+ * Describes the source event type that provided the membership data.
+ */
+declare enum MembershipKind {
     /**
-     * The sticky key in case of a sticky event. This string encodes the application + device_id indicating the used slot + device.
+     * The modern MSC4143 format event.
      */
-    "msc4354_sticky_key"?: string;
+    RTC = "rtc",
     /**
-     * The id used on the media backend.
-     * (With livekit this is the participant identity on the LK SFU)
-     * This can be a UUID but right now it is `${this.matrixEventData.sender}:${data.device_id}`.
-     *
-     * It is compleatly valid to not set this field. Other clients will treat `undefined` as `${this.matrixEventData.sender}:${data.device_id}`
+     * The legacy call event type.
      */
-    "membershipID"?: string;
-};
+    Session = "session"
+}
 type MembershipData = {
-    kind: "rtc";
+    kind: MembershipKind.RTC;
     data: RtcMembershipData;
 } | {
-    kind: "session";
+    kind: MembershipKind.Session;
     data: SessionMembershipData;
 };
+type LimitedEvent = Pick<MatrixEvent, "getId" | "getSender" | "getTs" | "getType" | "getContent">;
 export declare class CallMembership {
+    /** The Matrix event that this membership is based on */
+    private readonly matrixEvent;
+    private readonly membershipData;
+    readonly rtcBackendIdentity: string;
     /**
-     * The type checked membership data {data: (content of the matrix event), kind: (type hint)}
-     *
+     * Parse the membershipdata from a call membership event.
+     * @param matrixEvent The Matrix event to read.
+     * @returns MembershipData in either MembershipKind.RTC or MembershipKind.Session format.
+     * @throws If the content is neither format.
      */
-    private readonly membershipData;
+    static membershipDataFromMatrixEvent(matrixEvent: LimitedEvent): MembershipData;
     /**
-     *
-     * Anonymized identity to use with the RTC backend.
-     *
-     * The rtcBackendIdentity is a hashed version of all the identity parts:
-     * `sha256(${this.userId}|${this.deviceId}|${this.memberId})`
-     *
-     * It is used to anonymize the identity of the user in the RTC backend.
+     * Parse the contents of a MatrixEvent and create a CallMembership instance.
+     * @param matrixEvent The Matrix event to read.
      */
-    readonly rtcBackendIdentity: string;
+    static parseFromEvent(matrixEvent: LimitedEvent): Promise<CallMembership>;
     static equal(a?: CallMembership, b?: CallMembership): boolean;
-    private logger?;
+    private logger;
     /** The parsed data from the Matrix event.
      * To access checked eventId and sender from the matrixEvent.
      * Class construction will fail if these values cannot get obtained. */
     private readonly matrixEventData;
-    constructor(
-    /** The required parts of the Matrix event that this membership is based on */
-    matrixEvent: Pick<MatrixEvent, "getId" | "getSender" | "getTs">, 
-    /**
-     * The type checked membership data {data: (content of the matrix event), kind: (type hint)}
-     *
-     */
-    membershipData: MembershipData, 
-    /**
-     *
-     * Anonymized identity to use with the RTC backend.
-     *
-     * The rtcBackendIdentity is a hashed version of all the identity parts:
-     * `sha256(${this.userId}|${this.deviceId}|${this.memberId})`
-     *
-     * It is used to anonymize the identity of the user in the RTC backend.
-     */
-    rtcBackendIdentity: string, 
-    /**
-     * The constructor will automatically create a properly tagged child logger instance.
-     */
-    logger?: Logger);
     /**
-     * sha256(`${this.userId}|${this.deviceId}|${this.memberId}`) for sticky events (kind = rtc)
-     * `${this.userId}:${this.deviceId}` for state events (kind = session)
+     * Use `parseFromEvent`.
+     * Constructor should only be used by tests.
+     * @private
+     * @param matrixEvent
+     * @param membershipData
+     * @param rtcBackendIdentity
      */
-    static computeRtcBackendIdentity(matrixEvent: Pick<MatrixEvent, "getSender">, membershipData: MembershipData): Promise<string>;
-    static computeRtcIdentityRaw(userId: string, deviceId: string, memberId: string): Promise<string>;
-    static membershipDataFromMatrixEvent(matrixEvent: MatrixEvent): MembershipData;
+    constructor(
+    /** The Matrix event that this membership is based on */
+    matrixEvent: LimitedEvent, membershipData: MembershipData, rtcBackendIdentity: string);
     /** @deprecated use userId instead */
     get sender(): string;
     get userId(): string;
@@ -176,17 +77,21 @@ export declare class CallMembership {
      * Parsed `slot_id` (format `{application}#{id}`) into its components (application and id).
      */
     get slotDescription(): SlotDescription;
+    /**
+     * The application `type`.
+     * @deprecated Use @see applicationData
+     */
     get application(): string;
+    /**
+     * Information about the application being used for the RTC session.
+     * May contain extra keys specific to the application.
+     */
     get applicationData(): {
         type: string;
         [key: string]: unknown;
     };
     /** @deprecated scope is not used and will be removed in future versions. replaced by application specific types.*/
-    get scope(): CallScope | undefined;
-    /**
-     * @deprecated renamed to `memberId`
-     */
-    get membershipID(): string;
+    get scope(): SessionMembershipData["scope"] | undefined;
     /**
      * This computes the membership ID for the membership.
      * For the sticky event based rtcSessionData this is trivial it is `member.id`.
@@ -202,6 +107,10 @@ export declare class CallMembership {
      * It is also possible for a session event to set a custom membershipID. in that case this will be used.
      */
     get memberId(): string;
+    /**
+     * @deprecated renamed to `memberId`
+     */
+    get membershipID(): string;
     createdTs(): number;
     /**
      * Gets the absolute expiry timestamp of the membership.
@@ -210,6 +119,7 @@ export declare class CallMembership {
     getAbsoluteExpiry(): number | undefined;
     /**
      * @returns The number of milliseconds until the membership expires or undefined if applicable
+     * @deprecated Not used by RTC events.
      */
     getMsUntilExpiry(): number | undefined;
     /**
@@ -234,17 +144,11 @@ export declare class CallMembership {
      * @returns The transport this membership uses to publish media or undefined if no transport is available.
      */
     getTransport(oldestMembership: CallMembership): Transport | undefined;
-    /**
-     * The focus_active filed of the session membership (m.call.member).
-     * @deprecated focus_active is not used and will be removed in future versions.
-     */
-    getFocusActive(): LivekitFocusSelection | undefined;
     /**
      * The value of the `rtc_transports` field for RTC memberships (m.rtc.member).
      * Or the value of the `foci_preferred` field for legacy session memberships (m.call.member).
      */
     get transports(): Transport[];
-    get kind(): MembershipData["kind"];
 }
 export {};
 //# sourceMappingURL=CallMembership.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"CallMembership.d.ts","sourceRoot":"","sources":["../../src/matrixrtc/CallMembership.ts"],"names":[],"mappings":"AAkBA,OAAO,EAAE,KAAK,qBAAqB,EAAE,MAAM,uBAAuB,CAAC;AACnE,OAAO,EAA4C,KAAK,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACvG,OAAO,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC3D,OAAO,EAAE,KAAK,WAAW,EAAiB,MAAM,oBAAoB,CAAC;AACrE,OAAO,EAAE,KAAK,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAGvD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAE3C;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,QAAqB,CAAC;AAE1D,KAAK,SAAS,GAAG,QAAQ,GAAG,QAAQ,CAAC;AACrC,KAAK,MAAM,GAAG;IACV,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,EAAE,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,iBAAiB;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,CAAC,EAAE;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,YAAY,CAAC,SAAS,CAAC;KACpC,CAAC;IACF,aAAa,EAAE;QACX,IAAI,EAAE,MAAM,CAAC;QAEb,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC;KAC1B,CAAC;IACF,gBAAgB,EAAE,SAAS,EAAE,CAAC;IAC9B,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAmFD;;;IAGI;AACJ,MAAM,MAAM,qBAAqB,GAAG;IAChC;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;;;OAKG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,cAAc,EAAE,qBAAqB,CAAC;IAEtC;;;OAGG;IACH,gBAAgB,EAAE,SAAS,EAAE,CAAC;IAE9B;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAItB;;;OAGG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC;IAEpB;;;;QAII;IACJ,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,CAAC,EAAE,aAAa,CAAC;IAChC;;OAEG;IACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CAC3B,CAAC;AAqCF,KAAK,cAAc,GAAG;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,IAAI,EAAE,qBAAqB,CAAA;CAAE,CAAC;AAElH,qBAAa,cAAc;IAenB;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc;IAE/B;;;;;;;;OAQG;aACa,kBAAkB,EAAE,MAAM;WA7BhC,KAAK,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE,cAAc,GAAG,OAAO;IAIpE,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB;;2EAEuE;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAkD;;IAG9E,8EAA8E;IAC9E,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,WAAW,GAAG,OAAO,CAAC;IAE/D;;;OAGG;IACc,cAAc,EAAE,cAAc;IAE/C;;;;;;;;OAQG;IACa,kBAAkB,EAAE,MAAM;IAC1C;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM;IAWnB;;;OAGG;WACiB,yBAAyB,CACzC,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,WAAW,CAAC,EAC3C,cAAc,EAAE,cAAc,GAC/B,OAAO,CAAC,MAAM,CAAC;WAWE,qBAAqB,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;WAIhG,6BAA6B,CAAC,WAAW,EAAE,WAAW,GAAG,cAAc;IAsBrF,qCAAqC;IACrC,IAAW,MAAM,IAAI,MAAM,CAE1B;IACD,IAAW,MAAM,IAAI,MAAM,CAS1B;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;;OAGG;IACH,IAAW,MAAM,IAAI,MAAM,CAkD1B;IAED,IAAW,QAAQ,IAAI,MAAM,CAS5B;IAED,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAejD;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED,IAAW,WAAW,IAAI,MAAM,CAS/B;IACD,IAAW,eAAe,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CASrE;IAED,mHAAmH;IACnH,IAAW,KAAK,IAAI,SAAS,GAAG,SAAS,CASxC;IACD;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;;;;;;;;;;;;OAaG;IACH,IAAW,QAAQ,IAAI,MAAM,CAiB5B;IAEM,SAAS,IAAI,MAAM;IAY1B;;;OAGG;IACI,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAY9C;;OAEG;IACI,gBAAgB,IAAI,MAAM,GAAG,SAAS;IAc7C;;OAEG;IACI,SAAS,IAAI,OAAO;IAW3B;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,CAAC,gBAAgB,EAAE,cAAc,GAAG,SAAS,GAAG,SAAS;IAkB5E;;;OAGG;IACI,cAAc,IAAI,qBAAqB,GAAG,SAAS;IAK1D;;;OAGG;IACH,IAAW,UAAU,IAAI,SAAS,EAAE,CASnC;IACD,IAAW,IAAI,IAAI,cAAc,CAAC,MAAM,CAAC,CAExC;CACJ"}
+{"version":3,"file":"CallMembership.d.ts","sourceRoot":"","sources":["../../src/matrixrtc/CallMembership.ts"],"names":[],"mappings":"AAiBA,OAAO,EAAE,KAAK,aAAa,EAAE,KAAK,SAAS,EAAE,KAAK,eAAe,EAAE,MAAM,YAAY,CAAC;AACtF,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAGtD,OAAO,EAGH,KAAK,iBAAiB,EAEtB,KAAK,qBAAqB,EAE7B,MAAM,2BAA2B,CAAC;AAGnC;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,QAAqB,CAAC;AAE1D;;GAEG;AACH,aAAK,cAAc;IACf;;OAEG;IACH,GAAG,QAAQ;IACX;;OAEG;IACH,OAAO,YAAY;CACtB;AAED,KAAK,cAAc,GACb;IAAE,IAAI,EAAE,cAAc,CAAC,GAAG,CAAC;IAAC,IAAI,EAAE,iBAAiB,CAAA;CAAE,GACrD;IAAE,IAAI,EAAE,cAAc,CAAC,OAAO,CAAC;IAAC,IAAI,EAAE,qBAAqB,CAAA;CAAE,CAAC;AAEpE,KAAK,YAAY,GAAG,IAAI,CAAC,WAAW,EAAE,OAAO,GAAG,WAAW,GAAG,OAAO,GAAG,SAAS,GAAG,YAAY,CAAC,CAAC;AAElG,qBAAa,cAAc;IAkEnB,wDAAwD;IACxD,OAAO,CAAC,QAAQ,CAAC,WAAW;IAC5B,OAAO,CAAC,QAAQ,CAAC,cAAc;aACf,kBAAkB,EAAE,MAAM;IApE9C;;;;;OAKG;WACW,6BAA6B,CAAC,WAAW,EAAE,YAAY,GAAG,cAAc;IAsBtF;;;OAGG;WACiB,cAAc,CAAC,WAAW,EAAE,YAAY,GAAG,OAAO,CAAC,cAAc,CAAC;WAaxE,KAAK,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,EAAE,cAAc,GAAG,OAAO;IAIpE,OAAO,CAAC,MAAM,CAAS;IAEvB;;2EAEuE;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAsC;IAEtE;;;;;;;OAOG;;IAEC,wDAAwD;IACvC,WAAW,EAAE,YAAY,EACzB,cAAc,EAAE,cAAc,EAC/B,kBAAkB,EAAE,MAAM;IAY9C,qCAAqC;IACrC,IAAW,MAAM,IAAI,MAAM,CAE1B;IAED,IAAW,MAAM,IAAI,MAAM,CAS1B;IAED,IAAW,OAAO,IAAI,MAAM,CAE3B;IAED;;;OAGG;IACH,IAAW,MAAM,IAAI,MAAM,CAgD1B;IAED,IAAW,QAAQ,IAAI,MAAM,CAS5B;IAED,IAAW,UAAU,IAAI,aAAa,GAAG,SAAS,CAOjD;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAO5C;IAED;;;OAGG;IACH,IAAW,WAAW,IAAI,MAAM,CAE/B;IAED;;;OAGG;IACH,IAAW,eAAe,IAAI;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAWrE;IAED,mHAAmH;IACnH,IAAW,KAAK,IAAI,qBAAqB,CAAC,OAAO,CAAC,GAAG,SAAS,CAS7D;IAED;;;;;;;;;;;;;OAaG;IACH,IAAW,QAAQ,IAAI,MAAM,CAkB5B;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,MAAM,CAEhC;IAEM,SAAS,IAAI,MAAM;IAY1B;;;OAGG;IACI,iBAAiB,IAAI,MAAM,GAAG,SAAS;IAY9C;;;OAGG;IACI,gBAAgB,IAAI,MAAM,GAAG,SAAS;IAc7C;;OAEG;IACI,SAAS,IAAI,OAAO;IAW3B;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,CAAC,gBAAgB,EAAE,cAAc,GAAG,SAAS,GAAG,SAAS;IAuB5E;;;OAGG;IACH,IAAW,UAAU,IAAI,SAAS,EAAE,CASnC;CACJ"}