@fishjam-cloud/webrtc-client 0.25.0 → 0.25.2

package/dist/protobufs/fishjam/media_events/shared.d.ts

@@ -0,0 +1,48 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export declare const protobufPackage = "fishjam.media_events";
+export declare enum Variant {
+    VARIANT_UNSPECIFIED = 0,
+    VARIANT_LOW = 1,
+    VARIANT_MEDIUM = 2,
+    VARIANT_HIGH = 3,
+    UNRECOGNIZED = -1
+}
+export declare function variantFromJSON(object: any): Variant;
+export declare function variantToJSON(object: Variant): string;
+/** Contains information about an ICE candidate which will be sent to the peer/server */
+export interface Candidate {
+    candidate: string;
+    sdpMLineIndex: number;
+    sdpMid: string;
+    usernameFragment: string;
+}
+export interface ChannelMessageBinaryPayload {
+    data: Uint8Array;
+}
+export interface ChannelMessage {
+    source: string;
+    destinations: string[];
+    binary?: ChannelMessageBinaryPayload | undefined;
+}
+export declare const Candidate: MessageFns<Candidate>;
+export declare const ChannelMessageBinaryPayload: MessageFns<ChannelMessageBinaryPayload>;
+export declare const ChannelMessage: MessageFns<ChannelMessage>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+type KeysOfUnion<T> = T extends T ? keyof T : never;
+export type Exact<P, I extends P> = P extends Builtin ? P : P & {
+    [K in keyof P]: Exact<P[K], I[K]>;
+} & {
+    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
+};
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
+    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
+}
+export {};

package/dist/protobufs/fishjam/media_events/shared.js

@@ -0,0 +1,315 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// versions:
+//   protoc-gen-ts_proto  v2.7.0
+//   protoc               v6.33.0
+// source: fishjam/media_events/shared.proto
+/* eslint-disable */
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+export const protobufPackage = "fishjam.media_events";
+export var Variant;
+(function (Variant) {
+    Variant[Variant["VARIANT_UNSPECIFIED"] = 0] = "VARIANT_UNSPECIFIED";
+    Variant[Variant["VARIANT_LOW"] = 1] = "VARIANT_LOW";
+    Variant[Variant["VARIANT_MEDIUM"] = 2] = "VARIANT_MEDIUM";
+    Variant[Variant["VARIANT_HIGH"] = 3] = "VARIANT_HIGH";
+    Variant[Variant["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(Variant || (Variant = {}));
+export function variantFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "VARIANT_UNSPECIFIED":
+            return Variant.VARIANT_UNSPECIFIED;
+        case 1:
+        case "VARIANT_LOW":
+            return Variant.VARIANT_LOW;
+        case 2:
+        case "VARIANT_MEDIUM":
+            return Variant.VARIANT_MEDIUM;
+        case 3:
+        case "VARIANT_HIGH":
+            return Variant.VARIANT_HIGH;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return Variant.UNRECOGNIZED;
+    }
+}
+export function variantToJSON(object) {
+    switch (object) {
+        case Variant.VARIANT_UNSPECIFIED:
+            return "VARIANT_UNSPECIFIED";
+        case Variant.VARIANT_LOW:
+            return "VARIANT_LOW";
+        case Variant.VARIANT_MEDIUM:
+            return "VARIANT_MEDIUM";
+        case Variant.VARIANT_HIGH:
+            return "VARIANT_HIGH";
+        case Variant.UNRECOGNIZED:
+        default:
+            return "UNRECOGNIZED";
+    }
+}
+function createBaseCandidate() {
+    return { candidate: "", sdpMLineIndex: 0, sdpMid: "", usernameFragment: "" };
+}
+export const Candidate = {
+    encode(message, writer = new BinaryWriter()) {
+        if (message.candidate !== "") {
+            writer.uint32(10).string(message.candidate);
+        }
+        if (message.sdpMLineIndex !== 0) {
+            writer.uint32(16).int32(message.sdpMLineIndex);
+        }
+        if (message.sdpMid !== "") {
+            writer.uint32(26).string(message.sdpMid);
+        }
+        if (message.usernameFragment !== "") {
+            writer.uint32(34).string(message.usernameFragment);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseCandidate();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.candidate = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.sdpMLineIndex = reader.int32();
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.sdpMid = reader.string();
+                    continue;
+                }
+                case 4: {
+                    if (tag !== 34) {
+                        break;
+                    }
+                    message.usernameFragment = reader.string();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            candidate: isSet(object.candidate) ? globalThis.String(object.candidate) : "",
+            sdpMLineIndex: isSet(object.sdpMLineIndex) ? globalThis.Number(object.sdpMLineIndex) : 0,
+            sdpMid: isSet(object.sdpMid) ? globalThis.String(object.sdpMid) : "",
+            usernameFragment: isSet(object.usernameFragment) ? globalThis.String(object.usernameFragment) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.candidate !== "") {
+            obj.candidate = message.candidate;
+        }
+        if (message.sdpMLineIndex !== 0) {
+            obj.sdpMLineIndex = Math.round(message.sdpMLineIndex);
+        }
+        if (message.sdpMid !== "") {
+            obj.sdpMid = message.sdpMid;
+        }
+        if (message.usernameFragment !== "") {
+            obj.usernameFragment = message.usernameFragment;
+        }
+        return obj;
+    },
+    create(base) {
+        return Candidate.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseCandidate();
+        message.candidate = object.candidate ?? "";
+        message.sdpMLineIndex = object.sdpMLineIndex ?? 0;
+        message.sdpMid = object.sdpMid ?? "";
+        message.usernameFragment = object.usernameFragment ?? "";
+        return message;
+    },
+};
+function createBaseChannelMessageBinaryPayload() {
+    return { data: new Uint8Array(0) };
+}
+export const ChannelMessageBinaryPayload = {
+    encode(message, writer = new BinaryWriter()) {
+        if (message.data.length !== 0) {
+            writer.uint32(10).bytes(message.data);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseChannelMessageBinaryPayload();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.data = reader.bytes();
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { data: isSet(object.data) ? bytesFromBase64(object.data) : new Uint8Array(0) };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.data.length !== 0) {
+            obj.data = base64FromBytes(message.data);
+        }
+        return obj;
+    },
+    create(base) {
+        return ChannelMessageBinaryPayload.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseChannelMessageBinaryPayload();
+        message.data = object.data ?? new Uint8Array(0);
+        return message;
+    },
+};
+function createBaseChannelMessage() {
+    return { source: "", destinations: [], binary: undefined };
+}
+export const ChannelMessage = {
+    encode(message, writer = new BinaryWriter()) {
+        if (message.source !== "") {
+            writer.uint32(10).string(message.source);
+        }
+        for (const v of message.destinations) {
+            writer.uint32(18).string(v);
+        }
+        if (message.binary !== undefined) {
+            ChannelMessageBinaryPayload.encode(message.binary, writer.uint32(26).fork()).join();
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseChannelMessage();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1: {
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.source = reader.string();
+                    continue;
+                }
+                case 2: {
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.destinations.push(reader.string());
+                    continue;
+                }
+                case 3: {
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.binary = ChannelMessageBinaryPayload.decode(reader, reader.uint32());
+                    continue;
+                }
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skip(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            source: isSet(object.source) ? globalThis.String(object.source) : "",
+            destinations: globalThis.Array.isArray(object?.destinations)
+                ? object.destinations.map((e) => globalThis.String(e))
+                : [],
+            binary: isSet(object.binary) ? ChannelMessageBinaryPayload.fromJSON(object.binary) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.source !== "") {
+            obj.source = message.source;
+        }
+        if (message.destinations?.length) {
+            obj.destinations = message.destinations;
+        }
+        if (message.binary !== undefined) {
+            obj.binary = ChannelMessageBinaryPayload.toJSON(message.binary);
+        }
+        return obj;
+    },
+    create(base) {
+        return ChannelMessage.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseChannelMessage();
+        message.source = object.source ?? "";
+        message.destinations = object.destinations?.map((e) => e) || [];
+        message.binary = (object.binary !== undefined && object.binary !== null)
+            ? ChannelMessageBinaryPayload.fromPartial(object.binary)
+            : undefined;
+        return message;
+    },
+};
+function bytesFromBase64(b64) {
+    if (globalThis.Buffer) {
+        return Uint8Array.from(globalThis.Buffer.from(b64, "base64"));
+    }
+    else {
+        const bin = globalThis.atob(b64);
+        const arr = new Uint8Array(bin.length);
+        for (let i = 0; i < bin.length; ++i) {
+            arr[i] = bin.charCodeAt(i);
+        }
+        return arr;
+    }
+}
+function base64FromBytes(arr) {
+    if (globalThis.Buffer) {
+        return globalThis.Buffer.from(arr).toString("base64");
+    }
+    else {
+        const bin = [];
+        arr.forEach((byte) => {
+            bin.push(globalThis.String.fromCharCode(byte));
+        });
+        return globalThis.btoa(bin.join(""));
+    }
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/webrtc-client/src/CommandsQueue.d.ts

@@ -0,0 +1,23 @@
+import type { ConnectionManager } from './ConnectionManager';
+import type { Deferred } from './deferred';
+import type { LocalTrackManager } from './tracks/LocalTrackManager';
+export type Command = {
+    handler: () => Promise<void>;
+    parse?: () => void;
+    resolutionNotifier: Deferred<void>;
+    resolve: 'after-renegotiation' | 'on-handler-resolve';
+};
+export declare class CommandsQueue {
+    private readonly localTrackManager;
+    private connection;
+    private clearConnectionCallbacks;
+    constructor(localTrackManager: LocalTrackManager);
+    initConnection: (connection: ConnectionManager) => void;
+    private commandsQueue;
+    private commandResolutionNotifier;
+    pushCommand: (command: Command) => void;
+    processNextCommand: () => void;
+    private handleCommand;
+    private resolvePreviousCommand;
+    cleanUp: () => void;
+}

package/dist/webrtc-client/src/CommandsQueue.js

@@ -0,0 +1,87 @@
+export class CommandsQueue {
+    localTrackManager;
+    connection = null;
+    clearConnectionCallbacks = null;
+    constructor(localTrackManager) {
+        this.localTrackManager = localTrackManager;
+    }
+    initConnection = (connection) => {
+        this.connection = connection;
+        const onSignalingStateChange = () => {
+            if (connection.getConnection().signalingState === 'stable') {
+                this.processNextCommand();
+            }
+        };
+        const onIceGatheringStateChange = () => {
+            if (connection.getConnection().iceGatheringState === 'complete') {
+                this.processNextCommand();
+            }
+        };
+        const onConnectionStateChange = () => {
+            if (connection.getConnection().connectionState === 'connected') {
+                this.processNextCommand();
+            }
+        };
+        const onIceConnectionStateChange = () => {
+            if (connection.getConnection().iceConnectionState === 'connected') {
+                this.processNextCommand();
+            }
+        };
+        this.clearConnectionCallbacks = () => {
+            connection.getConnection().removeEventListener('signalingstatechange', onSignalingStateChange);
+            connection.getConnection().removeEventListener('icegatheringstatechange', onIceGatheringStateChange);
+            connection.getConnection().removeEventListener('connectionstatechange', onConnectionStateChange);
+            connection.getConnection().removeEventListener('iceconnectionstatechange', onIceConnectionStateChange);
+        };
+        connection.getConnection().addEventListener('icegatheringstatechange', onIceConnectionStateChange);
+        connection.getConnection().addEventListener('connectionstatechange', onConnectionStateChange);
+        connection.getConnection().addEventListener('iceconnectionstatechange', onIceConnectionStateChange);
+        connection.getConnection().addEventListener('signalingstatechange', onSignalingStateChange);
+    };
+    commandsQueue = [];
+    commandResolutionNotifier = null;
+    pushCommand = (command) => {
+        this.commandsQueue.push(command);
+        this.processNextCommand();
+    };
+    processNextCommand = () => {
+        if (this.localTrackManager.isNegotiationInProgress())
+            return;
+        if (this.connection?.isConnectionUnstable())
+            return;
+        this.resolvePreviousCommand();
+        const command = this.commandsQueue.shift();
+        if (!command)
+            return;
+        this.commandResolutionNotifier = command.resolutionNotifier;
+        this.handleCommand(command);
+    };
+    handleCommand = async (command) => {
+        try {
+            command.parse?.();
+            const promise = command.handler();
+            if (command.resolve === 'on-handler-resolve') {
+                await promise;
+                this.resolvePreviousCommand();
+                this.processNextCommand();
+            }
+        }
+        catch (error) {
+            this.commandResolutionNotifier?.reject(error);
+            this.commandResolutionNotifier = null;
+            this.processNextCommand();
+        }
+    };
+    resolvePreviousCommand = () => {
+        if (!this.commandResolutionNotifier)
+            return;
+        this.commandResolutionNotifier.resolve();
+        this.commandResolutionNotifier = null;
+    };
+    cleanUp = () => {
+        this.commandResolutionNotifier?.reject('Disconnected');
+        this.commandResolutionNotifier = null;
+        this.commandsQueue = [];
+        this.clearConnectionCallbacks?.();
+    };
+}

package/dist/webrtc-client/src/ConnectionManager.d.ts

@@ -0,0 +1,17 @@
+import type { MediaEvent_OfferData_TrackTypes } from '@fishjam-cloud/protobufs/server';
+import type { MediaStreamTrackId } from './types';
+export declare class ConnectionManager {
+    private readonly connection;
+    constructor(iceServers: RTCIceServer[]);
+    isConnectionUnstable: () => boolean;
+    getConnection: () => RTCPeerConnection;
+    addTransceiversIfNeeded: (serverTracks: MediaEvent_OfferData_TrackTypes) => void;
+    addTransceiver: (track: MediaStreamTrack, transceiverConfig: RTCRtpTransceiverInit) => void;
+    setOnTrackReady: (onTrackReady: (event: RTCTrackEvent) => void) => void;
+    setRemoteDescription: (data: RTCSessionDescriptionInit) => Promise<void>;
+    isTrackInUse: (track: MediaStreamTrack) => boolean;
+    removeTrack: (sender: RTCRtpSender) => void;
+    findSender: (mediaStreamTrackId: MediaStreamTrackId) => RTCRtpSender;
+    addIceCandidate: (iceCandidate: RTCIceCandidate) => Promise<void>;
+    createDataChannel: (label: string, config: RTCDataChannelInit) => RTCDataChannel;
+}

package/dist/webrtc-client/src/ConnectionManager.js

@@ -0,0 +1,49 @@
+export class ConnectionManager {
+    connection;
+    constructor(iceServers) {
+        this.connection = new RTCPeerConnection({
+            bundlePolicy: 'max-bundle',
+            iceServers: iceServers,
+            iceTransportPolicy: 'all',
+        });
+    }
+    isConnectionUnstable = () => {
+        if (!this.connection)
+            return false;
+        const isSignalingUnstable = this.connection.signalingState !== 'stable';
+        const isConnectionNotConnected = this.connection.connectionState !== 'connected';
+        const isIceNotConnected = this.connection.iceConnectionState !== 'connected';
+        return isSignalingUnstable && isConnectionNotConnected && isIceNotConnected;
+    };
+    getConnection = () => {
+        return this.connection;
+    };
+    addTransceiversIfNeeded = (serverTracks) => {
+        const recvTransceivers = this.connection.getTransceivers().filter((elem) => elem.direction === 'recvonly');
+        const videoTransceiversAmount = recvTransceivers.filter((elem) => elem.receiver.track.kind === 'video').length;
+        const audioTransceiversAmount = recvTransceivers.filter((elem) => elem.receiver.track.kind === 'audio').length;
+        const videoNeededTypes = Array(serverTracks.video - videoTransceiversAmount).fill('video');
+        const audioNeededTypes = Array(serverTracks.audio - audioTransceiversAmount).fill('audio');
+        [...videoNeededTypes, ...audioNeededTypes].forEach((kind) => this.connection.addTransceiver(kind, { direction: 'recvonly' }));
+    };
+    addTransceiver = (track, transceiverConfig) => {
+        this.connection.addTransceiver(track, transceiverConfig);
+    };
+    setOnTrackReady = (onTrackReady) => {
+        this.connection.ontrack = onTrackReady;
+    };
+    setRemoteDescription = async (data) => {
+        await this.connection.setRemoteDescription(data);
+    };
+    isTrackInUse = (track) => this.connection.getSenders().some((val) => val.track === track);
+    removeTrack = (sender) => {
+        this.connection.removeTrack(sender);
+    };
+    findSender = (mediaStreamTrackId) => this.connection.getSenders().find((sender) => sender.track && sender.track.id === mediaStreamTrackId);
+    addIceCandidate = async (iceCandidate) => {
+        await this.connection.addIceCandidate(iceCandidate);
+    };
+    createDataChannel = (label, config) => {
+        return this.connection.createDataChannel(label, config);
+    };
+}

package/dist/webrtc-client/src/bitrate.d.ts

@@ -0,0 +1,12 @@
+import { Variant } from '@fishjam-cloud/protobufs/shared';
+import { type BandwidthLimit } from './types';
+export type Bitrate = number;
+export type Bitrates = Record<Variant, Bitrate> | Bitrate;
+export declare const defaultBitrates: {
+    readonly audio: Bitrate;
+    readonly video: Bitrate;
+};
+export declare const UNLIMITED_BANDWIDTH: Bitrate;
+export declare const defaultSimulcastBitrates: {
+    [key in Variant]: BandwidthLimit;
+};

package/dist/webrtc-client/src/bitrate.js

@@ -0,0 +1,15 @@
+import { Variant } from '@fishjam-cloud/protobufs/shared';
+// The suggested bitrate values are based on our internal tests.
+export const defaultBitrates = {
+    audio: 50_000,
+    video: 2_500_000,
+};
+export const UNLIMITED_BANDWIDTH = 0;
+// The suggested bitrate values are based on our internal tests.
+export const defaultSimulcastBitrates = {
+    [Variant.VARIANT_HIGH]: 2_500_000,
+    [Variant.VARIANT_MEDIUM]: 500_000,
+    [Variant.VARIANT_LOW]: 150_000,
+    [Variant.VARIANT_UNSPECIFIED]: 0,
+    [Variant.UNRECOGNIZED]: 0,
+};

package/dist/webrtc-client/src/dataChannels/DataChannel.d.ts

@@ -0,0 +1,56 @@
+import type { DataCallback, DataChannelStatus, DataChannelType, Logger } from '../types';
+/**
+ * Wrapper class for RTCDataChannel.
+ * Handles bidirectional data transmission.
+ * @internal
+ */
+export declare class DataChannel {
+    private readonly type;
+    private readonly logger;
+    private channel;
+    private dataCallback;
+    private openCallback;
+    private errorCallback;
+    private _status;
+    constructor(type: DataChannelType, logger: Logger);
+    /**
+     * Get the current status of the data channel
+     */
+    get status(): DataChannelStatus;
+    /**
+     * Set the underlying RTCDataChannel and set up event listeners
+     */
+    setChannel(channel: RTCDataChannel): void;
+    /**
+     * Set callback to be called when the channel is opened
+     */
+    setOnOpen(callback: () => void): void;
+    /**
+     * Set callback to be called when the channel errors
+     */
+    setOnError(callback: (error: Event) => void): void;
+    /**
+     * Send data through the channel
+     * @param data - The data to send as Uint8Array
+     */
+    send(data: Uint8Array): void;
+    /**
+     * Set the callback for receiving data
+     * @param callback - Function to call when data is received
+     */
+    setCallback(callback: DataCallback): void;
+    /**
+     * Close the data channel
+     */
+    close(): void;
+    /**
+     * Set up event listeners for the RTCDataChannel
+     * @private
+     */
+    private setupListeners;
+    /**
+     * Handle incoming message data
+     * @private
+     */
+    private handleMessage;
+}