@textrp/briij-js-sdk 41.0.1 → 42.0.0

package/src/version-support.ts

@@ -1,50 +1,50 @@
-/*
-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.
-*/
-
-/**
- * A list of the spec versions which the js-sdk is compatible with.
- *
- * In practice, this means: when we connect to a server, it must declare support for one of the versions in this list.
- *
- * Note that it does not *necessarily* mean that the js-sdk has good support for all the features in the listed spec
- * versions; only that we should be able to provide a base level of functionality with a server that offers support for
- * any of the listed versions.
- */
-export const SUPPORTED_MATRIX_VERSIONS = [
-    "v1.1",
-    "v1.2",
-    "v1.3",
-    "v1.4",
-    "v1.5",
-    "v1.6",
-    "v1.7",
-    "v1.8",
-    "v1.9",
-    "v1.10",
-    "v1.11",
-    "v1.12",
-    "v1.13",
-];
-
-/**
- * The oldest Matrix specification version the js-sdk supports.
- */
-export const MINIMUM_MATRIX_VERSION = SUPPORTED_MATRIX_VERSIONS[0];
-
-/**
- * The most recent Matrix specification version the js-sdk supports.
- */
-export const MAXIMUM_MATRIX_VERSION = SUPPORTED_MATRIX_VERSIONS[SUPPORTED_MATRIX_VERSIONS.length - 1];
+/*
+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.
+*/
+
+/**
+ * A list of the spec versions which the js-sdk is compatible with.
+ *
+ * In practice, this means: when we connect to a server, it must declare support for one of the versions in this list.
+ *
+ * Note that it does not *necessarily* mean that the js-sdk has good support for all the features in the listed spec
+ * versions; only that we should be able to provide a base level of functionality with a server that offers support for
+ * any of the listed versions.
+ */
+export const SUPPORTED_MATRIX_VERSIONS = [
+    "v1.1",
+    "v1.2",
+    "v1.3",
+    "v1.4",
+    "v1.5",
+    "v1.6",
+    "v1.7",
+    "v1.8",
+    "v1.9",
+    "v1.10",
+    "v1.11",
+    "v1.12",
+    "v1.13",
+];
+
+/**
+ * The oldest Matrix specification version the js-sdk supports.
+ */
+export const MINIMUM_MATRIX_VERSION = SUPPORTED_MATRIX_VERSIONS[0];
+
+/**
+ * The most recent Matrix specification version the js-sdk supports.
+ */
+export const MAXIMUM_MATRIX_VERSION = SUPPORTED_MATRIX_VERSIONS[SUPPORTED_MATRIX_VERSIONS.length - 1];

package/src/webrtc/audioContext.ts

@@ -1,44 +1,44 @@
-/*
-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.
-*/
-
-let audioContext: AudioContext | null = null;
-let refCount = 0;
-
-/**
- * Acquires a reference to the shared AudioContext.
- * It's highly recommended to reuse this AudioContext rather than creating your
- * own, because multiple AudioContexts can be problematic in some browsers.
- * Make sure to call releaseContext when you're done using it.
- * @returns The shared AudioContext
- */
-export const acquireContext = (): AudioContext => {
-    if (audioContext === null) audioContext = new AudioContext();
-    refCount++;
-    return audioContext;
-};
-
-/**
- * Signals that one of the references to the shared AudioContext has been
- * released, allowing the context and associated hardware resources to be
- * cleaned up if nothing else is using it.
- */
-export const releaseContext = (): void => {
-    refCount--;
-    if (refCount === 0) {
-        audioContext?.close();
-        audioContext = null;
-    }
-};
+/*
+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.
+*/
+
+let audioContext: AudioContext | null = null;
+let refCount = 0;
+
+/**
+ * Acquires a reference to the shared AudioContext.
+ * It's highly recommended to reuse this AudioContext rather than creating your
+ * own, because multiple AudioContexts can be problematic in some browsers.
+ * Make sure to call releaseContext when you're done using it.
+ * @returns The shared AudioContext
+ */
+export const acquireContext = (): AudioContext => {
+    if (audioContext === null) audioContext = new AudioContext();
+    refCount++;
+    return audioContext;
+};
+
+/**
+ * Signals that one of the references to the shared AudioContext has been
+ * released, allowing the context and associated hardware resources to be
+ * cleaned up if nothing else is using it.
+ */
+export const releaseContext = (): void => {
+    refCount--;
+    if (refCount === 0) {
+        audioContext?.close();
+        audioContext = null;
+    }
+};

package/src/webrtc/callEventTypes.ts

@@ -1,101 +1,101 @@
-// allow non-camelcase as these are events type that go onto the wire
-/* eslint-disable camelcase */
-
-import { type CallErrorCode } from "./call.ts";
-import { NamespacedValue } from "../NamespacedValue.ts";
-
-export const SDPStreamMetadataKey = new NamespacedValue(
-    "sdp_stream_metadata",
-    "org.matrix.msc3077.sdp_stream_metadata",
-);
-
-export enum SDPStreamMetadataPurpose {
-    Usermedia = "m.usermedia",
-    Screenshare = "m.screenshare",
-}
-
-export interface SDPStreamMetadataObject {
-    purpose: SDPStreamMetadataPurpose;
-    audio_muted: boolean;
-    video_muted: boolean;
-}
-
-export interface SDPStreamMetadata {
-    [key: string]: SDPStreamMetadataObject;
-}
-
-export interface CallCapabilities {
-    "m.call.transferee": boolean;
-    "m.call.dtmf": boolean;
-}
-
-export interface CallReplacesTarget {
-    id: string;
-    display_name: string;
-    avatar_url: string;
-}
-
-export interface MCallBase {
-    call_id: string;
-    conf_id?: string;
-    version: string | number;
-    party_id?: string;
-    sender_session_id?: string;
-    dest_session_id?: string;
-}
-
-type Description = Pick<RTCSessionDescription, "type" | "sdp">;
-
-export interface MCallAnswer extends MCallBase {
-    "answer": Description;
-    "capabilities"?: CallCapabilities;
-    "sdp_stream_metadata"?: SDPStreamMetadata;
-    "org.matrix.msc3077.sdp_stream_metadata"?: SDPStreamMetadata;
-}
-
-export interface MCallSelectAnswer extends MCallBase {
-    selected_party_id: string;
-}
-
-export interface MCallInviteNegotiate extends MCallBase {
-    "offer": Description;
-    "description": Description;
-    "lifetime": number;
-    "capabilities"?: CallCapabilities;
-    "invitee"?: string;
-    "sender_session_id"?: string;
-    "dest_session_id"?: string;
-    "sdp_stream_metadata"?: SDPStreamMetadata;
-    "org.matrix.msc3077.sdp_stream_metadata"?: SDPStreamMetadata;
-}
-
-export interface MCallSDPStreamMetadataChanged extends MCallBase {
-    "sdp_stream_metadata"?: SDPStreamMetadata;
-    "org.matrix.msc3077.sdp_stream_metadata"?: SDPStreamMetadata;
-}
-
-export interface MCallReplacesEvent extends MCallBase {
-    replacement_id: string;
-    target_user: CallReplacesTarget;
-    create_call: string;
-    await_call: string;
-    target_room: string;
-}
-
-export interface MCAllAssertedIdentity extends MCallBase {
-    asserted_identity: {
-        id: string;
-        display_name: string;
-        avatar_url: string;
-    };
-}
-
-export interface MCallCandidates extends MCallBase {
-    candidates: Omit<RTCIceCandidateInit, "usernameFragment">[];
-}
-
-export interface MCallHangupReject extends MCallBase {
-    reason?: CallErrorCode;
-}
-
-/* eslint-enable camelcase */
+// allow non-camelcase as these are events type that go onto the wire
+/* eslint-disable camelcase */
+
+import { type CallErrorCode } from "./call.ts";
+import { NamespacedValue } from "../NamespacedValue.ts";
+
+export const SDPStreamMetadataKey = new NamespacedValue(
+    "sdp_stream_metadata",
+    "org.matrix.msc3077.sdp_stream_metadata",
+);
+
+export enum SDPStreamMetadataPurpose {
+    Usermedia = "m.usermedia",
+    Screenshare = "m.screenshare",
+}
+
+export interface SDPStreamMetadataObject {
+    purpose: SDPStreamMetadataPurpose;
+    audio_muted: boolean;
+    video_muted: boolean;
+}
+
+export interface SDPStreamMetadata {
+    [key: string]: SDPStreamMetadataObject;
+}
+
+export interface CallCapabilities {
+    "m.call.transferee": boolean;
+    "m.call.dtmf": boolean;
+}
+
+export interface CallReplacesTarget {
+    id: string;
+    display_name: string;
+    avatar_url: string;
+}
+
+export interface MCallBase {
+    call_id: string;
+    conf_id?: string;
+    version: string | number;
+    party_id?: string;
+    sender_session_id?: string;
+    dest_session_id?: string;
+}
+
+type Description = Pick<RTCSessionDescription, "type" | "sdp">;
+
+export interface MCallAnswer extends MCallBase {
+    "answer": Description;
+    "capabilities"?: CallCapabilities;
+    "sdp_stream_metadata"?: SDPStreamMetadata;
+    "org.matrix.msc3077.sdp_stream_metadata"?: SDPStreamMetadata;
+}
+
+export interface MCallSelectAnswer extends MCallBase {
+    selected_party_id: string;
+}
+
+export interface MCallInviteNegotiate extends MCallBase {
+    "offer": Description;
+    "description": Description;
+    "lifetime": number;
+    "capabilities"?: CallCapabilities;
+    "invitee"?: string;
+    "sender_session_id"?: string;
+    "dest_session_id"?: string;
+    "sdp_stream_metadata"?: SDPStreamMetadata;
+    "org.matrix.msc3077.sdp_stream_metadata"?: SDPStreamMetadata;
+}
+
+export interface MCallSDPStreamMetadataChanged extends MCallBase {
+    "sdp_stream_metadata"?: SDPStreamMetadata;
+    "org.matrix.msc3077.sdp_stream_metadata"?: SDPStreamMetadata;
+}
+
+export interface MCallReplacesEvent extends MCallBase {
+    replacement_id: string;
+    target_user: CallReplacesTarget;
+    create_call: string;
+    await_call: string;
+    target_room: string;
+}
+
+export interface MCAllAssertedIdentity extends MCallBase {
+    asserted_identity: {
+        id: string;
+        display_name: string;
+        avatar_url: string;
+    };
+}
+
+export interface MCallCandidates extends MCallBase {
+    candidates: Omit<RTCIceCandidateInit, "usernameFragment">[];
+}
+
+export interface MCallHangupReject extends MCallBase {
+    reason?: CallErrorCode;
+}
+
+/* eslint-enable camelcase */

package/src/webrtc/stats/callFeedStatsReporter.ts

@@ -1,91 +1,91 @@
-/*
-Copyright 2023 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 CallFeedReport, type CallFeedStats, type TrackStats, type TransceiverStats } from "./statsReport.ts";
-import { type CallFeed } from "../callFeed.ts";
-
-export class CallFeedStatsReporter {
-    public static buildCallFeedReport(callId: string, opponentMemberId: string, pc: RTCPeerConnection): CallFeedReport {
-        const rtpTransceivers = pc.getTransceivers();
-        const transceiver: TransceiverStats[] = [];
-        const callFeeds: CallFeedStats[] = [];
-
-        rtpTransceivers.forEach((t) => {
-            const sender = t.sender?.track ? CallFeedStatsReporter.buildTrackStats(t.sender.track, "sender") : null;
-            const receiver = CallFeedStatsReporter.buildTrackStats(t.receiver.track, "receiver");
-            transceiver.push({
-                mid: t.mid == null ? "null" : t.mid,
-                direction: t.direction,
-                currentDirection: t.currentDirection == null ? "null" : t.currentDirection,
-                sender,
-                receiver,
-            });
-        });
-
-        return {
-            callId,
-            opponentMemberId,
-            transceiver,
-            callFeeds,
-        };
-    }
-
-    private static buildTrackStats(track: MediaStreamTrack, label = "--"): TrackStats {
-        const settingDeviceId = track.getSettings()?.deviceId;
-        const constrainDeviceId = track.getConstraints()?.deviceId;
-
-        return {
-            id: track.id,
-            kind: track.kind,
-            settingDeviceId: settingDeviceId ?? "unknown",
-            constrainDeviceId: constrainDeviceId ?? "unknown",
-            muted: track.muted,
-            enabled: track.enabled,
-            readyState: track.readyState,
-            label,
-        } as TrackStats;
-    }
-
-    public static expandCallFeedReport(
-        report: CallFeedReport,
-        callFeeds: CallFeed[],
-        prefix = "unknown",
-    ): CallFeedReport {
-        callFeeds.forEach((feed) => {
-            const audioTracks = feed.stream.getAudioTracks();
-            const videoTracks = feed.stream.getVideoTracks();
-            const audio =
-                audioTracks.length > 0
-                    ? CallFeedStatsReporter.buildTrackStats(feed.stream.getAudioTracks()[0], feed.purpose)
-                    : null;
-            const video =
-                videoTracks.length > 0
-                    ? CallFeedStatsReporter.buildTrackStats(feed.stream.getVideoTracks()[0], feed.purpose)
-                    : null;
-            const feedStats = {
-                stream: feed.stream.id,
-                type: feed.isLocal() ? "local" : "remote",
-                audio,
-                video,
-                purpose: feed.purpose,
-                prefix,
-                isVideoMuted: feed.isVideoMuted(),
-                isAudioMuted: feed.isAudioMuted(),
-            } as CallFeedStats;
-            report.callFeeds.push(feedStats);
-        });
-        return report;
-    }
-}
+/*
+Copyright 2023 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 CallFeedReport, type CallFeedStats, type TrackStats, type TransceiverStats } from "./statsReport.ts";
+import { type CallFeed } from "../callFeed.ts";
+
+export class CallFeedStatsReporter {
+    public static buildCallFeedReport(callId: string, opponentMemberId: string, pc: RTCPeerConnection): CallFeedReport {
+        const rtpTransceivers = pc.getTransceivers();
+        const transceiver: TransceiverStats[] = [];
+        const callFeeds: CallFeedStats[] = [];
+
+        rtpTransceivers.forEach((t) => {
+            const sender = t.sender?.track ? CallFeedStatsReporter.buildTrackStats(t.sender.track, "sender") : null;
+            const receiver = CallFeedStatsReporter.buildTrackStats(t.receiver.track, "receiver");
+            transceiver.push({
+                mid: t.mid == null ? "null" : t.mid,
+                direction: t.direction,
+                currentDirection: t.currentDirection == null ? "null" : t.currentDirection,
+                sender,
+                receiver,
+            });
+        });
+
+        return {
+            callId,
+            opponentMemberId,
+            transceiver,
+            callFeeds,
+        };
+    }
+
+    private static buildTrackStats(track: MediaStreamTrack, label = "--"): TrackStats {
+        const settingDeviceId = track.getSettings()?.deviceId;
+        const constrainDeviceId = track.getConstraints()?.deviceId;
+
+        return {
+            id: track.id,
+            kind: track.kind,
+            settingDeviceId: settingDeviceId ?? "unknown",
+            constrainDeviceId: constrainDeviceId ?? "unknown",
+            muted: track.muted,
+            enabled: track.enabled,
+            readyState: track.readyState,
+            label,
+        } as TrackStats;
+    }
+
+    public static expandCallFeedReport(
+        report: CallFeedReport,
+        callFeeds: CallFeed[],
+        prefix = "unknown",
+    ): CallFeedReport {
+        callFeeds.forEach((feed) => {
+            const audioTracks = feed.stream.getAudioTracks();
+            const videoTracks = feed.stream.getVideoTracks();
+            const audio =
+                audioTracks.length > 0
+                    ? CallFeedStatsReporter.buildTrackStats(feed.stream.getAudioTracks()[0], feed.purpose)
+                    : null;
+            const video =
+                videoTracks.length > 0
+                    ? CallFeedStatsReporter.buildTrackStats(feed.stream.getVideoTracks()[0], feed.purpose)
+                    : null;
+            const feedStats = {
+                stream: feed.stream.id,
+                type: feed.isLocal() ? "local" : "remote",
+                audio,
+                video,
+                purpose: feed.purpose,
+                prefix,
+                isVideoMuted: feed.isVideoMuted(),
+                isAudioMuted: feed.isAudioMuted(),
+            } as CallFeedStats;
+            report.callFeeds.push(feedStats);
+        });
+        return report;
+    }
+}