@textrp/briij-js-sdk 41.0.1 → 43.0.0

package/src/matrixrtc/IMembershipManager.ts

@@ -1,120 +1,120 @@
-/*
-Copyright 2025 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 { CallMembership } from "./CallMembership.ts";
-import type { RTCCallIntent, Status, Transport } from "./types.ts";
-import { type TypedEventEmitter } from "../models/typed-event-emitter.ts";
-
-export enum MembershipManagerEvent {
-    StatusChanged = "StatusChanged",
-    /**
-     * Emitted when the membership manager has not heard back from the server for the duration
-     * of the delayed event and hence failed to restart the delayed event.
-     * This means that the user is probably not joined anymore and the leave event was distributed to other session members.
-     */
-    ProbablyLeft = "ProbablyLeft",
-    /**
-     * Once the membershipManger has aquired the a delay id (after sending the state event)
-     * It will emit and share the delay id.
-     */
-    DelayIdChanged = "DelayIdChanged",
-}
-
-export type MembershipManagerEventHandlerMap = {
-    [MembershipManagerEvent.StatusChanged]: (prefStatus: Status, newStatus: Status) => void;
-    [MembershipManagerEvent.ProbablyLeft]: (probablyLeft: boolean) => void;
-    [MembershipManagerEvent.DelayIdChanged]: (delayId: string | undefined) => void;
-};
-
-/**
- * This interface defines what a MembershipManager uses and exposes.
- * This interface is what we use to write tests and allows changing the actual implementation
- * without breaking tests because of some internal method renaming.
- *
- * @internal
- */
-export interface IMembershipManager extends TypedEventEmitter<
-    MembershipManagerEvent,
-    MembershipManagerEventHandlerMap
-> {
-    /**
-     * If we are trying to join, or have successfully joined the session.
-     * It does not reflect if the room state is already configured to represent us being joined.
-     * It only means that the Manager should be trying to connect or to disconnect running.
-     * The Manager is still running right after isJoined becomes false to send the disconnect events.
-     * @returns true if we intend to be participating in the MatrixRTC session
-     * @deprecated This name is confusing and replaced by `isActivated()`. (Returns the same as `isActivated()`)
-     */
-    isJoined(): boolean;
-    /**
-     * If the manager is activated. This means it tries to do its job to join the call, resend state events...
-     * It does not imply that the room state is already configured to represent being joined.
-     * It means that the Manager tries to connect or is connected. ("the manager is still active")
-     * Once `leave()` is called the manager is not activated anymore but still running until `leave()` resolves.
-     * @returns `true` if we intend to be participating in the MatrixRTC session
-     */
-    isActivated(): boolean;
-    /**
-     * Get the actual connection status of the manager.
-     */
-    get status(): Status;
-
-    /**
-     * The Current own state event if the manger is connected.
-     * `undefined` if not connected.
-     */
-    get ownMembership(): CallMembership | undefined;
-
-    /**
-     * If the membership manager has reason to believe that the hs sent a leave event
-     * and as a consequence the current user is perceived as left for other session participants.
-     */
-    get probablyLeft(): boolean;
-
-    /**
-     * If the membership manager has reason to believe that the hs sent a leave event
-     * and as a consequence the current user is perceived as left for other session participants.
-     */
-    get delayId(): string | undefined;
-
-    /**
-     * Start sending all necessary events to make this user participate in the RTC session.
-     * @param fociPreferred the list of preferred foci to use in the joined RTC membership event.
-     * If multiSfuFocus is set, this is only needed if this client wants to publish to multiple transports simultaneously.
-     * @param multiSfuFocus the active focus to use in the joined RTC membership event. Setting this implies the
-     * membership manager will operate in a multi-SFU connection mode. If `undefined`, an `oldest_membership`
-     * transport selection will be used instead.
-     * @throws can throw if it exceeds a configured maximum retry.
-     */
-    join(fociPreferred: Transport[], multiSfuFocus?: Transport, onError?: (error: unknown) => void): void;
-    /**
-     * Send all necessary events to make this user leave the RTC session.
-     * @param timeout the maximum duration in ms until the promise is forced to resolve.
-     * @returns It resolves with true in case the leave was sent successfully.
-     * It resolves with false in case we hit the timeout before sending successfully.
-     */
-    leave(timeout?: number): Promise<boolean>;
-    /**
-     * Call this if the MatrixRTC session members have changed.
-     */
-    onRTCSessionMemberUpdate(memberships: CallMembership[]): Promise<void>;
-
-    /**
-     * Update the intent of a membership on the call (e.g. user is now providing a video feed)
-     * @param callIntent The new intent to set.
-     */
-    updateCallIntent(callIntent: RTCCallIntent): Promise<void>;
-}
+/*
+Copyright 2025 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 { CallMembership } from "./CallMembership.ts";
+import type { RTCCallIntent, Status, Transport } from "./types.ts";
+import { type TypedEventEmitter } from "../models/typed-event-emitter.ts";
+
+export enum MembershipManagerEvent {
+    StatusChanged = "StatusChanged",
+    /**
+     * Emitted when the membership manager has not heard back from the server for the duration
+     * of the delayed event and hence failed to restart the delayed event.
+     * This means that the user is probably not joined anymore and the leave event was distributed to other session members.
+     */
+    ProbablyLeft = "ProbablyLeft",
+    /**
+     * Once the membershipManger has aquired the a delay id (after sending the state event)
+     * It will emit and share the delay id.
+     */
+    DelayIdChanged = "DelayIdChanged",
+}
+
+export type MembershipManagerEventHandlerMap = {
+    [MembershipManagerEvent.StatusChanged]: (prefStatus: Status, newStatus: Status) => void;
+    [MembershipManagerEvent.ProbablyLeft]: (probablyLeft: boolean) => void;
+    [MembershipManagerEvent.DelayIdChanged]: (delayId: string | undefined) => void;
+};
+
+/**
+ * This interface defines what a MembershipManager uses and exposes.
+ * This interface is what we use to write tests and allows changing the actual implementation
+ * without breaking tests because of some internal method renaming.
+ *
+ * @internal
+ */
+export interface IMembershipManager extends TypedEventEmitter<
+    MembershipManagerEvent,
+    MembershipManagerEventHandlerMap
+> {
+    /**
+     * If we are trying to join, or have successfully joined the session.
+     * It does not reflect if the room state is already configured to represent us being joined.
+     * It only means that the Manager should be trying to connect or to disconnect running.
+     * The Manager is still running right after isJoined becomes false to send the disconnect events.
+     * @returns true if we intend to be participating in the MatrixRTC session
+     * @deprecated This name is confusing and replaced by `isActivated()`. (Returns the same as `isActivated()`)
+     */
+    isJoined(): boolean;
+    /**
+     * If the manager is activated. This means it tries to do its job to join the call, resend state events...
+     * It does not imply that the room state is already configured to represent being joined.
+     * It means that the Manager tries to connect or is connected. ("the manager is still active")
+     * Once `leave()` is called the manager is not activated anymore but still running until `leave()` resolves.
+     * @returns `true` if we intend to be participating in the MatrixRTC session
+     */
+    isActivated(): boolean;
+    /**
+     * Get the actual connection status of the manager.
+     */
+    get status(): Status;
+
+    /**
+     * The Current own state event if the manger is connected.
+     * `undefined` if not connected.
+     */
+    get ownMembership(): CallMembership | undefined;
+
+    /**
+     * If the membership manager has reason to believe that the hs sent a leave event
+     * and as a consequence the current user is perceived as left for other session participants.
+     */
+    get probablyLeft(): boolean;
+
+    /**
+     * If the membership manager has reason to believe that the hs sent a leave event
+     * and as a consequence the current user is perceived as left for other session participants.
+     */
+    get delayId(): string | undefined;
+
+    /**
+     * Start sending all necessary events to make this user participate in the RTC session.
+     * @param fociPreferred the list of preferred foci to use in the joined RTC membership event.
+     * If multiSfuFocus is set, this is only needed if this client wants to publish to multiple transports simultaneously.
+     * @param multiSfuFocus the active focus to use in the joined RTC membership event. Setting this implies the
+     * membership manager will operate in a multi-SFU connection mode. If `undefined`, an `oldest_membership`
+     * transport selection will be used instead.
+     * @throws can throw if it exceeds a configured maximum retry.
+     */
+    join(fociPreferred: Transport[], multiSfuFocus?: Transport, onError?: (error: unknown) => void): void;
+    /**
+     * Send all necessary events to make this user leave the RTC session.
+     * @param timeout the maximum duration in ms until the promise is forced to resolve.
+     * @returns It resolves with true in case the leave was sent successfully.
+     * It resolves with false in case we hit the timeout before sending successfully.
+     */
+    leave(timeout?: number): Promise<boolean>;
+    /**
+     * Call this if the MatrixRTC session members have changed.
+     */
+    onRTCSessionMemberUpdate(memberships: CallMembership[]): Promise<void>;
+
+    /**
+     * Update the intent of a membership on the call (e.g. user is now providing a video feed)
+     * @param callIntent The new intent to set.
+     */
+    updateCallIntent(callIntent: RTCCallIntent): Promise<void>;
+}

package/src/matrixrtc/LivekitTransport.ts

@@ -1,46 +1,46 @@
-/*
-Copyright 2025 New Vector Ltd
-
-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 Transport } from "./types.ts";
-
-export interface LivekitTransportConfig extends Transport {
-    type: "livekit";
-    livekit_service_url: string;
-}
-
-export const isLivekitTransportConfig = (object: any): object is LivekitTransportConfig =>
-    object.type === "livekit" && "livekit_service_url" in object;
-
-export interface LivekitTransport extends LivekitTransportConfig {
-    livekit_alias: string;
-}
-
-export const isLivekitTransport = (object: any): object is LivekitTransport =>
-    isLivekitTransportConfig(object) && "livekit_alias" in object;
-
-/**
- * @deprecated, this is just needed for the old focus active / focus fields of a call membership.
- * Not needed for new implementations.
- */
-export interface LivekitFocusSelection extends Transport {
-    type: "livekit";
-    focus_selection: "oldest_membership" | "multi_sfu";
-}
-/**
- * @deprecated see LivekitFocusSelection
- */
-export const isLivekitFocusSelection = (object: any): object is LivekitFocusSelection =>
-    object.type === "livekit" && "focus_selection" in object;
+/*
+Copyright 2025 New Vector Ltd
+
+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 Transport } from "./types.ts";
+
+export interface LivekitTransportConfig extends Transport {
+    type: "livekit";
+    livekit_service_url: string;
+}
+
+export const isLivekitTransportConfig = (object: any): object is LivekitTransportConfig =>
+    object.type === "livekit" && "livekit_service_url" in object;
+
+export interface LivekitTransport extends LivekitTransportConfig {
+    livekit_alias: string;
+}
+
+export const isLivekitTransport = (object: any): object is LivekitTransport =>
+    isLivekitTransportConfig(object) && "livekit_alias" in object;
+
+/**
+ * @deprecated, this is just needed for the old focus active / focus fields of a call membership.
+ * Not needed for new implementations.
+ */
+export interface LivekitFocusSelection extends Transport {
+    type: "livekit";
+    focus_selection: "oldest_membership" | "multi_sfu";
+}
+/**
+ * @deprecated see LivekitFocusSelection
+ */
+export const isLivekitFocusSelection = (object: any): object is LivekitFocusSelection =>
+    object.type === "livekit" && "focus_selection" in object;

package/src/matrixrtc/index.ts

@@ -1,24 +1,24 @@
-/*
-Copyright 2024 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.
-*/
-
-export * from "./CallMembership.ts";
-export * from "./LivekitTransport.ts";
-export * from "./MatrixRTCSession.ts";
-export * from "./MatrixRTCSessionManager.ts";
-export type * from "./types.ts";
-export { type SessionMembershipData, type RtcMembershipData } from "./membershipData/index.ts";
-export { Status, parseCallNotificationContent, isMyMembership } from "./types.ts";
-export { MembershipManagerEvent } from "./IMembershipManager.ts";
+/*
+Copyright 2024 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.
+*/
+
+export * from "./CallMembership.ts";
+export * from "./LivekitTransport.ts";
+export * from "./MatrixRTCSession.ts";
+export * from "./MatrixRTCSessionManager.ts";
+export type * from "./types.ts";
+export { type SessionMembershipData, type RtcMembershipData } from "./membershipData/index.ts";
+export { Status, parseCallNotificationContent, isMyMembership } from "./types.ts";
+export { MembershipManagerEvent } from "./IMembershipManager.ts";

package/src/matrixrtc/utils.ts

@@ -1,71 +1,71 @@
-/*
-Copyright 2025-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 { getEncryptionKeyMapKey, type CallMembershipIdentityParts } from "./EncryptionManager.ts";
-import type { InboundEncryptionSession, EncryptionKeyMapKey, SlotDescription } from "./types.ts";
-
-/**
- * Detects when a key for a given index is outdated.
- */
-export class OutdatedKeyFilter {
-    // Map of participantId -> keyIndex -> timestamp
-    private tsBuffer: Map<EncryptionKeyMapKey, Map<number, number>> = new Map();
-
-    public constructor() {}
-
-    /**
-     * Check if there is a recent key with the same keyId (index) and then use the creationTS to decide what to
-     * do with the key. If the key received is older than the one already in the buffer, it is ignored.
-     * @param participantId
-     * @param item
-     */
-    public isOutdated(membership: CallMembershipIdentityParts, item: InboundEncryptionSession): boolean {
-        const mapKey = getEncryptionKeyMapKey(membership);
-        if (!this.tsBuffer.has(mapKey)) {
-            this.tsBuffer.set(mapKey, new Map<number, number>());
-        }
-
-        const latestTimestamp = this.tsBuffer.get(mapKey)?.get(item.keyIndex);
-        if (latestTimestamp && latestTimestamp > item.creationTS) {
-            // The existing key is more recent, ignore this one
-            return true;
-        }
-        this.tsBuffer.get(mapKey)!.set(item.keyIndex, item.creationTS);
-        return false;
-    }
-}
-
-/**
- * Converts a slot ID into it's component application and ID portions.
- * @param slotId e.g. `m.call#call_id`
- * @throws If the format of `slotId` is invalid.
- */
-export function slotIdToDescription(slotId: string): SlotDescription {
-    const [application, id, ...unexpectedAdditionalValues] = slotId.split("#");
-    if (unexpectedAdditionalValues.length) {
-        throw Error(
-            "MatrixRTC Slot IDs *must* only contain two components seperated by one '#'. Additional '#' characters detected.",
-        );
-    }
-    return { application, id };
-}
-
-/**
- * Converts a SlotDescription into it's slot ID format.
- */
-export function computeSlotId(slotDescription: SlotDescription): string {
-    return `${slotDescription.application}#${slotDescription.id}`;
-}
+/*
+Copyright 2025-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 { getEncryptionKeyMapKey, type CallMembershipIdentityParts } from "./EncryptionManager.ts";
+import type { InboundEncryptionSession, EncryptionKeyMapKey, SlotDescription } from "./types.ts";
+
+/**
+ * Detects when a key for a given index is outdated.
+ */
+export class OutdatedKeyFilter {
+    // Map of participantId -> keyIndex -> timestamp
+    private tsBuffer: Map<EncryptionKeyMapKey, Map<number, number>> = new Map();
+
+    public constructor() {}
+
+    /**
+     * Check if there is a recent key with the same keyId (index) and then use the creationTS to decide what to
+     * do with the key. If the key received is older than the one already in the buffer, it is ignored.
+     * @param participantId
+     * @param item
+     */
+    public isOutdated(membership: CallMembershipIdentityParts, item: InboundEncryptionSession): boolean {
+        const mapKey = getEncryptionKeyMapKey(membership);
+        if (!this.tsBuffer.has(mapKey)) {
+            this.tsBuffer.set(mapKey, new Map<number, number>());
+        }
+
+        const latestTimestamp = this.tsBuffer.get(mapKey)?.get(item.keyIndex);
+        if (latestTimestamp && latestTimestamp > item.creationTS) {
+            // The existing key is more recent, ignore this one
+            return true;
+        }
+        this.tsBuffer.get(mapKey)!.set(item.keyIndex, item.creationTS);
+        return false;
+    }
+}
+
+/**
+ * Converts a slot ID into it's component application and ID portions.
+ * @param slotId e.g. `m.call#call_id`
+ * @throws If the format of `slotId` is invalid.
+ */
+export function slotIdToDescription(slotId: string): SlotDescription {
+    const [application, id, ...unexpectedAdditionalValues] = slotId.split("#");
+    if (unexpectedAdditionalValues.length) {
+        throw Error(
+            "MatrixRTC Slot IDs *must* only contain two components seperated by one '#'. Additional '#' characters detected.",
+        );
+    }
+    return { application, id };
+}
+
+/**
+ * Converts a SlotDescription into it's slot ID format.
+ */
+export function computeSlotId(slotDescription: SlotDescription): string {
+    return `${slotDescription.application}#${slotDescription.id}`;
+}

package/src/models/ToDeviceMessage.ts

@@ -1,38 +1,38 @@
-/*
-Copyright 2022 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.
-*/
-
-export type ToDevicePayload = Record<string, any>;
-
-export interface ToDeviceMessage {
-    userId: string;
-    deviceId: string;
-    payload: ToDevicePayload;
-}
-
-export interface ToDeviceBatch {
-    eventType: string;
-    batch: ToDeviceMessage[];
-}
-
-// Only used internally
-export interface ToDeviceBatchWithTxnId extends ToDeviceBatch {
-    txnId: string;
-}
-
-// Only used internally
-export interface IndexedToDeviceBatch extends ToDeviceBatchWithTxnId {
-    id: number;
-}
+/*
+Copyright 2022 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.
+*/
+
+export type ToDevicePayload = Record<string, any>;
+
+export interface ToDeviceMessage {
+    userId: string;
+    deviceId: string;
+    payload: ToDevicePayload;
+}
+
+export interface ToDeviceBatch {
+    eventType: string;
+    batch: ToDeviceMessage[];
+}
+
+// Only used internally
+export interface ToDeviceBatchWithTxnId extends ToDeviceBatch {
+    txnId: string;
+}
+
+// Only used internally
+export interface IndexedToDeviceBatch extends ToDeviceBatchWithTxnId {
+    id: number;
+}