@fishjam-cloud/ts-client 0.7.1 → 0.8.0

package/dist/src/protos/fishjam/peer_notifications.d.ts

@@ -1,4 +1,4 @@
-import * as _m0 from "protobufjs/minimal";
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 export declare const protobufPackage = "fishjam";
 /** Defines any type of message sent between FJ and a peer */
 export interface PeerMessage {
@@ -25,46 +25,11 @@ export interface PeerMessage_MediaEvent {
 export interface PeerMessage_RTCStatsReport {
     data: string;
 }
-export declare const PeerMessage: {
-    encode(message: PeerMessage, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage;
-    fromJSON(object: any): PeerMessage;
-    toJSON(message: PeerMessage): unknown;
-    create<I extends Exact<DeepPartial<PeerMessage>, I>>(base?: I): PeerMessage;
-    fromPartial<I extends Exact<DeepPartial<PeerMessage>, I>>(object: I): PeerMessage;
-};
-export declare const PeerMessage_Authenticated: {
-    encode(_: PeerMessage_Authenticated, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage_Authenticated;
-    fromJSON(_: any): PeerMessage_Authenticated;
-    toJSON(_: PeerMessage_Authenticated): unknown;
-    create<I extends Exact<DeepPartial<PeerMessage_Authenticated>, I>>(base?: I): PeerMessage_Authenticated;
-    fromPartial<I extends Exact<DeepPartial<PeerMessage_Authenticated>, I>>(_: I): PeerMessage_Authenticated;
-};
-export declare const PeerMessage_AuthRequest: {
-    encode(message: PeerMessage_AuthRequest, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage_AuthRequest;
-    fromJSON(object: any): PeerMessage_AuthRequest;
-    toJSON(message: PeerMessage_AuthRequest): unknown;
-    create<I extends Exact<DeepPartial<PeerMessage_AuthRequest>, I>>(base?: I): PeerMessage_AuthRequest;
-    fromPartial<I extends Exact<DeepPartial<PeerMessage_AuthRequest>, I>>(object: I): PeerMessage_AuthRequest;
-};
-export declare const PeerMessage_MediaEvent: {
-    encode(message: PeerMessage_MediaEvent, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage_MediaEvent;
-    fromJSON(object: any): PeerMessage_MediaEvent;
-    toJSON(message: PeerMessage_MediaEvent): unknown;
-    create<I extends Exact<DeepPartial<PeerMessage_MediaEvent>, I>>(base?: I): PeerMessage_MediaEvent;
-    fromPartial<I extends Exact<DeepPartial<PeerMessage_MediaEvent>, I>>(object: I): PeerMessage_MediaEvent;
-};
-export declare const PeerMessage_RTCStatsReport: {
-    encode(message: PeerMessage_RTCStatsReport, writer?: _m0.Writer): _m0.Writer;
-    decode(input: _m0.Reader | Uint8Array, length?: number): PeerMessage_RTCStatsReport;
-    fromJSON(object: any): PeerMessage_RTCStatsReport;
-    toJSON(message: PeerMessage_RTCStatsReport): unknown;
-    create<I extends Exact<DeepPartial<PeerMessage_RTCStatsReport>, I>>(base?: I): PeerMessage_RTCStatsReport;
-    fromPartial<I extends Exact<DeepPartial<PeerMessage_RTCStatsReport>, I>>(object: I): PeerMessage_RTCStatsReport;
-};
+export declare const PeerMessage: MessageFns<PeerMessage>;
+export declare const PeerMessage_Authenticated: MessageFns<PeerMessage_Authenticated>;
+export declare const PeerMessage_AuthRequest: MessageFns<PeerMessage_AuthRequest>;
+export declare const PeerMessage_MediaEvent: MessageFns<PeerMessage_MediaEvent>;
+export declare const PeerMessage_RTCStatsReport: MessageFns<PeerMessage_RTCStatsReport>;
 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]>;
@@ -75,4 +40,12 @@ export type Exact<P, I extends P> = P extends Builtin ? P : P & {
 } & {
     [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/src/protos/fishjam/peer_notifications.js

@@ -1,66 +1,70 @@
 // Code generated by protoc-gen-ts_proto. DO NOT EDIT.
 // versions:
-//   protoc-gen-ts_proto  v1.181.1
-//   protoc               v4.25.1
+//   protoc-gen-ts_proto  v2.2.3
+//   protoc               v5.26.1
 // source: protos/fishjam/peer_notifications.proto
 /* eslint-disable */
-import * as _m0 from "protobufjs/minimal";
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
 export const protobufPackage = "fishjam";
 function createBasePeerMessage() {
     return { authenticated: undefined, authRequest: undefined, mediaEvent: undefined, rtcStatsReport: undefined };
 }
 export const PeerMessage = {
-    encode(message, writer = _m0.Writer.create()) {
+    encode(message, writer = new BinaryWriter()) {
         if (message.authenticated !== undefined) {
-            PeerMessage_Authenticated.encode(message.authenticated, writer.uint32(10).fork()).ldelim();
+            PeerMessage_Authenticated.encode(message.authenticated, writer.uint32(10).fork()).join();
         }
         if (message.authRequest !== undefined) {
-            PeerMessage_AuthRequest.encode(message.authRequest, writer.uint32(18).fork()).ldelim();
+            PeerMessage_AuthRequest.encode(message.authRequest, writer.uint32(18).fork()).join();
         }
         if (message.mediaEvent !== undefined) {
-            PeerMessage_MediaEvent.encode(message.mediaEvent, writer.uint32(26).fork()).ldelim();
+            PeerMessage_MediaEvent.encode(message.mediaEvent, writer.uint32(26).fork()).join();
         }
         if (message.rtcStatsReport !== undefined) {
-            PeerMessage_RTCStatsReport.encode(message.rtcStatsReport, writer.uint32(34).fork()).ldelim();
+            PeerMessage_RTCStatsReport.encode(message.rtcStatsReport, writer.uint32(34).fork()).join();
         }
         return writer;
     },
     decode(input, length) {
-        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
         let end = length === undefined ? reader.len : reader.pos + length;
         const message = createBasePeerMessage();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
-                case 1:
+                case 1: {
                     if (tag !== 10) {
                         break;
                     }
                     message.authenticated = PeerMessage_Authenticated.decode(reader, reader.uint32());
                     continue;
-                case 2:
+                }
+                case 2: {
                     if (tag !== 18) {
                         break;
                     }
                     message.authRequest = PeerMessage_AuthRequest.decode(reader, reader.uint32());
                     continue;
-                case 3:
+                }
+                case 3: {
                     if (tag !== 26) {
                         break;
                     }
                     message.mediaEvent = PeerMessage_MediaEvent.decode(reader, reader.uint32());
                     continue;
-                case 4:
+                }
+                case 4: {
                     if (tag !== 34) {
                         break;
                     }
                     message.rtcStatsReport = PeerMessage_RTCStatsReport.decode(reader, reader.uint32());
                     continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
-            reader.skipType(tag & 7);
+            reader.skip(tag & 7);
         }
         return message;
     },
@@ -114,11 +118,11 @@ function createBasePeerMessage_Authenticated() {
     return {};
 }
 export const PeerMessage_Authenticated = {
-    encode(_, writer = _m0.Writer.create()) {
+    encode(_, writer = new BinaryWriter()) {
         return writer;
     },
     decode(input, length) {
-        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
         let end = length === undefined ? reader.len : reader.pos + length;
         const message = createBasePeerMessage_Authenticated();
         while (reader.pos < end) {
@@ -128,7 +132,7 @@ export const PeerMessage_Authenticated = {
             if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
-            reader.skipType(tag & 7);
+            reader.skip(tag & 7);
         }
         return message;
     },
@@ -151,30 +155,31 @@ function createBasePeerMessage_AuthRequest() {
     return { token: "" };
 }
 export const PeerMessage_AuthRequest = {
-    encode(message, writer = _m0.Writer.create()) {
+    encode(message, writer = new BinaryWriter()) {
         if (message.token !== "") {
             writer.uint32(10).string(message.token);
         }
         return writer;
     },
     decode(input, length) {
-        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
         let end = length === undefined ? reader.len : reader.pos + length;
         const message = createBasePeerMessage_AuthRequest();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
-                case 1:
+                case 1: {
                     if (tag !== 10) {
                         break;
                     }
                     message.token = reader.string();
                     continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
-            reader.skipType(tag & 7);
+            reader.skip(tag & 7);
         }
         return message;
     },
@@ -201,30 +206,31 @@ function createBasePeerMessage_MediaEvent() {
     return { data: "" };
 }
 export const PeerMessage_MediaEvent = {
-    encode(message, writer = _m0.Writer.create()) {
+    encode(message, writer = new BinaryWriter()) {
         if (message.data !== "") {
             writer.uint32(10).string(message.data);
         }
         return writer;
     },
     decode(input, length) {
-        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
         let end = length === undefined ? reader.len : reader.pos + length;
         const message = createBasePeerMessage_MediaEvent();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
-                case 1:
+                case 1: {
                     if (tag !== 10) {
                         break;
                     }
                     message.data = reader.string();
                     continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
-            reader.skipType(tag & 7);
+            reader.skip(tag & 7);
         }
         return message;
     },
@@ -251,30 +257,31 @@ function createBasePeerMessage_RTCStatsReport() {
     return { data: "" };
 }
 export const PeerMessage_RTCStatsReport = {
-    encode(message, writer = _m0.Writer.create()) {
+    encode(message, writer = new BinaryWriter()) {
         if (message.data !== "") {
             writer.uint32(10).string(message.data);
         }
         return writer;
     },
     decode(input, length) {
-        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        const reader = input instanceof BinaryReader ? input : new BinaryReader(input);
         let end = length === undefined ? reader.len : reader.pos + length;
         const message = createBasePeerMessage_RTCStatsReport();
         while (reader.pos < end) {
             const tag = reader.uint32();
             switch (tag >>> 3) {
-                case 1:
+                case 1: {
                     if (tag !== 10) {
                         break;
                     }
                     message.data = reader.string();
                     continue;
+                }
             }
             if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
-            reader.skipType(tag & 7);
+            reader.skip(tag & 7);
         }
         return message;
     },

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

@@ -2,10 +2,10 @@ import type { Deferred } from './deferred';
 import type { LocalTrackManager } from './tracks/LocalTrackManager';
 import type { ConnectionManager } from './ConnectionManager';
 export type Command = {
-    handler: () => void;
+    handler: () => Promise<void>;
     parse?: () => void;
     resolutionNotifier: Deferred<void>;
-    resolve: 'after-renegotiation' | 'immediately';
+    resolve: 'after-renegotiation' | 'on-handler-resolve';
 };
 export declare class CommandsQueue<EndpointMetadata, TrackMetadata> {
     private readonly localTrackManager;

package/dist/src/webrtc/CommandsQueue.js

@@ -56,11 +56,12 @@ export class CommandsQueue {
         this.commandResolutionNotifier = command.resolutionNotifier;
         this.handleCommand(command);
     };
-    handleCommand = (command) => {
+    handleCommand = async (command) => {
         try {
             command.parse?.();
-            command.handler();
-            if (command.resolve === 'immediately') {
+            const promise = command.handler();
+            if (command.resolve === 'on-handler-resolve') {
+                await promise;
                 this.resolvePreviousCommand();
                 this.processNextCommand();
             }

package/dist/src/webrtc/tracks/LocalTrack.js

@@ -1,7 +1,8 @@
-import { generateCustomEvent, generateMediaEvent } from '../mediaEvent';
+import { generateCustomEvent } from '../mediaEvent';
 import { defaultBitrates, defaultSimulcastBitrates, UNLIMITED_BANDWIDTH } from '../bitrate';
 import { getEncodingParameters } from './encodings';
 import { createTransceiverConfig } from './transceivers';
+import { emitMutableEvents, getActionType } from './muteTrackUtils';
 /**
  * This is a wrapper over `TrackContext` that adds additional properties such as:
  * - `MLineId`: required to generate sdpOffer
@@ -99,6 +100,7 @@ export class LocalTrack {
     replaceTrack = async (newTrack, webrtc) => {
         const trackId = this.id;
         const stream = this.trackContext.stream;
+        const oldTrack = this.trackContext.track;
         if (!this.sender)
             throw Error('There is no RTCRtpSender for this track id!');
         stream?.getTracks().forEach((track) => {
@@ -107,25 +109,25 @@ export class LocalTrack {
         if (newTrack) {
             stream?.addTrack(newTrack);
         }
-        if (this.trackContext.track && !newTrack) {
-            const mediaEvent = generateMediaEvent('muteTrack', { trackId: trackId });
-            webrtc.sendMediaEvent(mediaEvent);
-            webrtc.emit('localTrackMuted', { trackId: trackId });
-        }
-        else if (!this.trackContext.track && newTrack) {
-            const mediaEvent = generateMediaEvent('unmuteTrack', {
-                trackId: trackId,
-            });
-            webrtc.sendMediaEvent(mediaEvent);
-            webrtc.emit('localTrackUnmuted', { trackId: trackId });
-        }
+        this.trackContext.track = newTrack;
         this.mediaStreamTrackId = newTrack?.id ?? null;
+        const action = getActionType(this.trackContext.track, newTrack);
+        if (action === 'mute' || action === 'unmute') {
+            emitMutableEvents(action, webrtc, trackId);
+        }
         try {
             await this.sender.replaceTrack(newTrack);
-            this.trackContext.track = newTrack;
         }
         catch (_error) {
-            // ignore
+            // rollback: emit opposite events and revert internal state
+            if (action === 'mute') {
+                emitMutableEvents('unmute', webrtc, trackId);
+            }
+            else if (action === 'unmute') {
+                emitMutableEvents('mute', webrtc, trackId);
+            }
+            this.trackContext.track = oldTrack;
+            this.mediaStreamTrackId = oldTrack?.id ?? null;
         }
     };
     setTrackBandwidth = (bandwidth) => {

package/dist/src/webrtc/tracks/muteTrackUtils.d.ts

@@ -0,0 +1,3 @@
+import type { WebRTCEndpoint } from '../webRTCEndpoint';
+export declare function emitMutableEvents<EndpointMetadata, TrackMetadata>(action: 'mute' | 'unmute', webrtc: WebRTCEndpoint<EndpointMetadata, TrackMetadata>, trackId: string): void;
+export declare function getActionType(currentTrack: MediaStreamTrack | null, newTrack: MediaStreamTrack | null): 'mute' | 'unmute' | 'replace';

package/dist/src/webrtc/tracks/muteTrackUtils.js

@@ -0,0 +1,19 @@
+import { generateMediaEvent } from '../mediaEvent';
+export function emitMutableEvents(action, webrtc, trackId) {
+    const mediaEventType = action === 'mute' ? `muteTrack` : `unmuteTrack`;
+    const localEventType = action === 'mute' ? `localTrackMuted` : `localTrackUnmuted`;
+    const mediaEvent = generateMediaEvent(mediaEventType, { trackId: trackId });
+    webrtc.sendMediaEvent(mediaEvent);
+    webrtc.emit(localEventType, { trackId: trackId });
+}
+export function getActionType(currentTrack, newTrack) {
+    if (currentTrack && !newTrack) {
+        return 'mute';
+    }
+    else if (!currentTrack && newTrack) {
+        return 'unmute';
+    }
+    else {
+        return 'replace';
+    }
+}

package/dist/src/webrtc/tracks/transceivers.js

@@ -16,8 +16,22 @@ const createAudioTransceiverConfig = (stream) => {
 const createVideoTransceiverConfig = (trackContext, maxBandwidth) => {
     if (!trackContext.simulcastConfig)
         throw new Error(`Simulcast config for track ${trackContext.trackId} not found.`);
-    if (typeof maxBandwidth !== 'number' && trackContext.simulcastConfig.enabled) {
-        return createSimulcastTransceiverConfig(trackContext, maxBandwidth);
+    if (trackContext.simulcastConfig.enabled) {
+        let simulcastConfig;
+        if (maxBandwidth === 0) {
+            simulcastConfig = new Map([
+                ['l', 0],
+                ['m', 0],
+                ['h', 0],
+            ]);
+        }
+        else if (typeof maxBandwidth === 'number') {
+            throw new Error('Invalid bandwidth limit for simulcast track.');
+        }
+        else {
+            simulcastConfig = maxBandwidth;
+        }
+        return createSimulcastTransceiverConfig(trackContext, simulcastConfig);
     }
     if (typeof maxBandwidth === 'number') {
         return createNonSimulcastTransceiverConfig(trackContext, maxBandwidth);

package/dist/src/webrtc/webRTCEndpoint.js

@@ -327,9 +327,7 @@ export class WebRTCEndpoint extends EventEmitter {
             metadata = parsedMetadata;
             stream.addTrack(track);
             this.commandsQueue.pushCommand({
-                handler: () => {
-                    this.localTrackManager.addTrackHandler(trackId, track, stream, parsedMetadata, simulcastConfig, maxBandwidth);
-                },
+                handler: async () => this.localTrackManager.addTrackHandler(trackId, track, stream, parsedMetadata, simulcastConfig, maxBandwidth),
                 parse: () => this.localTrackManager.parseAddTrack(track, simulcastConfig, maxBandwidth),
                 resolve: 'after-renegotiation',
                 resolutionNotifier,
@@ -397,11 +395,9 @@ export class WebRTCEndpoint extends EventEmitter {
     async replaceTrack(trackId, newTrack) {
         const resolutionNotifier = new Deferred();
         this.commandsQueue.pushCommand({
-            handler: () => {
-                this.localTrackManager.replaceTrackHandler(this, trackId, newTrack);
-            },
+            handler: () => this.localTrackManager.replaceTrackHandler(this, trackId, newTrack),
             resolutionNotifier,
-            resolve: 'immediately',
+            resolve: 'on-handler-resolve',
         });
         return resolutionNotifier.promise.then(() => {
             this.emit('localTrackReplaced', { trackId, track: newTrack });
@@ -466,9 +462,7 @@ export class WebRTCEndpoint extends EventEmitter {
     async removeTrack(trackId) {
         const resolutionNotifier = new Deferred();
         this.commandsQueue.pushCommand({
-            handler: () => {
-                this.localTrackManager.removeTrackHandler(trackId);
-            },
+            handler: async () => this.localTrackManager.removeTrackHandler(trackId),
             resolutionNotifier,
             resolve: 'after-renegotiation',
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishjam-cloud/ts-client",
-  "version": "0.7.1",
+  "version": "0.8.0",
   "description": "Typescript client library for Fishjam Cloud",
   "license": "Apache-2.0",
   "author": "Fishjam Cloud Team",
@@ -53,20 +53,20 @@
   "devDependencies": {
     "@playwright/test": "^1.47.2",
     "@types/events": "^3.0.3",
-    "@types/node": "^22.7.4",
+    "@types/node": "^22.7.5",
     "@types/uuid": "^10.0.0",
-    "@vitest/coverage-v8": "^2.1.1",
+    "@vitest/coverage-v8": "^2.1.2",
     "fake-mediastreamtrack": "^1.2.0",
     "husky": "^9.1.6",
     "lint-staged": "^15.2.10",
     "react": "^18.2.0",
-    "ts-proto": "^2.2.1",
+    "ts-proto": "^2.2.3",
     "typed-emitter": "^2.1.0",
-    "typedoc": "^0.26.7",
+    "typedoc": "^0.26.8",
     "typedoc-plugin-external-resolver": "^1.0.3",
     "typedoc-plugin-mdn-links": "^3.3.2",
     "typescript": "^5.6.2",
-    "vitest": "^2.1.1",
+    "vitest": "^2.1.2",
     "zod": "^3.23.6"
   },
   "lint-staged": {