@fishjam-cloud/ts-client 0.7.0 → 0.7.2

package/README.md

@@ -4,7 +4,12 @@
 
 # Fishjam TS Client
 
-TypeScript client library for [Fishjam Cloud](https://cloud.fishjam.stream).
+TypeScript client library for [Fishjam Cloud](https://fishjam.io).
+
+> [!WARNING]  
+> This SDK is not stable yet. We recommend to use
+> [React Client](https://github.com/fishjam-cloud/web-client-sdk/tree/main/packages/react-client) for Fishjam Cloud
+> services.
 
 ## Documentation
 
@@ -33,10 +38,11 @@ yarn @fishjam-cloud/ts-client
 
 Prerequisites:
 
-- Account on [Fishjam Cloud](https://cloud.fishjam.stream) with App configured.
+- Account on [Fishjam Cloud](https://https://fishjam.io) with App configured.
 - Created room and token of peer in that room. You can use Room Manager to create room and peer token.
 
-The following code snippet is based on the [minimal](../../examples/ts-client/minimal/) example.
+The following code snippet is based on the
+[minimal](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/ts-client/minimal/) example.
 
 ```ts
 import { FishjamClient, WebRTCEndpoint } from '@fishjam-cloud/ts-client';
@@ -119,12 +125,18 @@ async function startScreenSharing(webrtc: WebRTCEndpoint) {
 
 ## Examples
 
-For more examples, see the [examples](../../examples/ts-client/) folder.
+For more examples, see the [examples](https://github.com/fishjam-cloud/web-client-sdk/tree/main/examples/ts-client/)
+folder.
+
+## License
 
-## Copyright and License
+Licensed under the [Apache License, Version 2.0](LICENSE)
 
-Copyright 2024, [Software Mansion](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam-ts)
+## Fishjam Cloud is created by Software Mansion
 
-[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=fishjam-github)](https://swmansion.com/?utm_source=git&utm_medium=readme&utm_campaign=fishjam-ts)
+Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile
+apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help
+you build your next dream product –
+[Hire us](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=web-readme).
 
-Licensed under the [Apache License, Version 2.0](LICENSE)
+[![Software Mansion](https://logo.swmansion.com/logo?color=white&variant=desktop&width=200&tag=react-client)](https://swmansion.com/contact/projects?utm_source=fishjam&utm_medium=web-readme)

package/dist/src/reconnection.js

@@ -61,7 +61,7 @@ export class ReconnectManager {
         this.reconnectTimeoutId = null;
     }
     getLastPeerMetadata() {
-        return this.lastLocalEndpoint?.metadata;
+        return this.lastLocalEndpoint?.metadata?.peer;
     }
     reconnect() {
         if (this.reconnectTimeoutId)

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/Local.js

@@ -13,8 +13,14 @@ export class Local {
     localEndpoint = {
         id: '',
         type: 'webrtc',
-        metadata: undefined,
-        rawMetadata: undefined,
+        metadata: {
+            peer: undefined,
+            server: undefined,
+        },
+        rawMetadata: {
+            peer: undefined,
+            server: undefined,
+        },
         tracks: new Map(),
     };
     endpointMetadataParser;
@@ -96,15 +102,15 @@ export class Local {
     };
     setEndpointMetadata = (metadata) => {
         try {
-            this.localEndpoint.metadata = this.endpointMetadataParser(metadata);
+            this.localEndpoint.metadata.peer = this.endpointMetadataParser(metadata);
             this.localEndpoint.metadataParsingError = undefined;
         }
         catch (error) {
-            this.localEndpoint.metadata = undefined;
+            this.localEndpoint.metadata.peer = undefined;
             this.localEndpoint.metadataParsingError = error;
             throw error;
         }
-        this.localEndpoint.rawMetadata = metadata;
+        this.localEndpoint.rawMetadata.peer = metadata;
     };
     getEndpoint = () => {
         return this.localEndpoint;
@@ -149,11 +155,11 @@ export class Local {
         });
     };
     updateEndpointMetadata = (metadata) => {
-        this.localEndpoint.metadata = this.endpointMetadataParser(metadata);
+        this.localEndpoint.metadata.peer = this.endpointMetadataParser(metadata);
         this.localEndpoint.rawMetadata = this.localEndpoint.metadata;
         this.localEndpoint.metadataParsingError = undefined;
         const mediaEvent = generateMediaEvent('updateEndpointMetadata', {
-            metadata: this.localEndpoint.metadata,
+            metadata: this.localEndpoint.metadata.peer,
         });
         this.sendMediaEvent(mediaEvent);
         this.emit('localEndpointMetadataChanged', {

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/Remote.js

@@ -56,13 +56,13 @@ export class Remote {
         const newEndpoint = {
             id: endpoint.id,
             type: endpoint.type,
-            metadata: undefined,
-            rawMetadata: undefined,
+            metadata: { peer: undefined, server: undefined },
+            rawMetadata: { peer: undefined, server: undefined },
             metadataParsingError: undefined,
             tracks: new Map(),
         };
         // mutation in place
-        this.updateEndpointMetadata(newEndpoint, endpoint.metadata);
+        this.updateEndpointMetadata(newEndpoint, endpoint?.metadata?.peer);
         this.addEndpoint(newEndpoint);
         this.addTracks(newEndpoint.id, endpoint.tracks, endpoint.trackIdToMetadata);
         if (sendNotification) {
@@ -77,19 +77,19 @@ export class Remote {
         if (!endpoint)
             throw new Error(`Endpoint ${data.id} not found`);
         // mutation in place
-        this.updateEndpointMetadata(endpoint, data.metadata);
+        this.updateEndpointMetadata(endpoint, data.metadata.peer);
         this.emit('endpointUpdated', endpoint);
     };
     updateEndpointMetadata = (endpoint, metadata) => {
         try {
-            endpoint.metadata = this.endpointMetadataParser(metadata);
+            endpoint.metadata.peer = this.endpointMetadataParser(metadata);
             endpoint.metadataParsingError = undefined;
         }
         catch (error) {
-            endpoint.metadata = undefined;
+            endpoint.metadata.peer = undefined;
             endpoint.metadataParsingError = error;
         }
-        endpoint.rawMetadata = metadata;
+        endpoint.rawMetadata.peer = metadata;
     };
     removeRemoteEndpoint = (endpointId) => {
         const endpoint = this.remoteEndpoints[endpointId];

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/types.d.ts

@@ -268,7 +268,10 @@ export interface WebRTCEndpointEvents<EndpointMetadata, TrackMetadata> {
         encoding: Encoding;
     }) => void;
     localEndpointMetadataChanged: (event: {
-        metadata: EndpointMetadata;
+        metadata: {
+            peer?: EndpointMetadata;
+            server?: unknown;
+        };
     }) => void;
     localTrackMetadataChanged: (event: {
         trackId: string;
@@ -294,8 +297,14 @@ export interface Endpoint<EndpointMetadata, TrackMetadata> {
     /**
      * Any information that was provided in {@link WebRTCEndpoint.connect}.
      */
-    metadata?: EndpointMetadata;
-    rawMetadata: any;
+    metadata: {
+        peer?: EndpointMetadata;
+        server: any;
+    };
+    rawMetadata: {
+        peer?: any;
+        server: any;
+    };
     metadataParsingError?: any;
     /**
      * List of tracks that are sent by the endpoint.

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.0",
+  "version": "0.7.2",
   "description": "Typescript client library for Fishjam Cloud",
   "license": "Apache-2.0",
   "author": "Fishjam Cloud Team",
@@ -51,22 +51,22 @@
     "uuid": "^10.0.0"
   },
   "devDependencies": {
-    "@playwright/test": "^1.47.1",
+    "@playwright/test": "^1.47.2",
     "@types/events": "^3.0.3",
-    "@types/node": "^22.5.5",
+    "@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.0",
+    "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.2.12",
+    "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": {