@fishjam-cloud/ts-client 0.6.0 → 0.7.1

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

@@ -12,6 +12,11 @@ export type Component<PeerMetadata, TrackMetadata> = Omit<Endpoint<PeerMetadata,
  * Events emitted by the client with their arguments.
  */
 export interface MessageEvents<PeerMetadata, TrackMetadata> {
+    /**
+     * Emitted when connect method invoked
+     *
+     */
+    connectionStarted: () => void;
     /**
      * Emitted when the websocket connection is closed
      *
@@ -210,7 +215,7 @@ export declare class FishjamClient<PeerMetadata, TrackMetadata> extends FishjamC
      *
      * @param {ConnectConfig} config - Configuration object for the client
      */
-    connect(config: ConnectConfig<PeerMetadata>): void;
+    connect(config: ConnectConfig<PeerMetadata>): Promise<void>;
     private initConnection;
     private getUrl;
     private initWebsocket;

package/dist/src/FishjamClient.js

@@ -3,6 +3,7 @@ import { EventEmitter } from 'events';
 import { PeerMessage } from './protos';
 import { ReconnectManager } from './reconnection';
 import { isAuthError } from './auth';
+import { connectEventsHandler } from './connectEventsHandler';
 const STATISTICS_INTERVAL = 10_000;
 const isPeer = (endpoint) => endpoint.type === 'webrtc';
 const isComponent = (endpoint) => endpoint.type === 'recording' ||
@@ -77,10 +78,13 @@ export class FishjamClient extends EventEmitter {
      *
      * @param {ConnectConfig} config - Configuration object for the client
      */
-    connect(config) {
+    async connect(config) {
+        this.emit('connectionStarted');
+        const result = connectEventsHandler(this);
         this.reconnectManager.reset(config.peerMetadata);
         this.connectConfig = config;
         this.initConnection(config.peerMetadata);
+        return result;
     }
     async initConnection(peerMetadata) {
         if (this.status === 'initialized') {

package/dist/src/connectEventsHandler.d.ts

@@ -0,0 +1,2 @@
+import type { FishjamClient } from './FishjamClient';
+export declare function connectEventsHandler<P, T>(fishjamClient: FishjamClient<P, T>): Promise<void>;

package/dist/src/connectEventsHandler.js

@@ -0,0 +1,22 @@
+export function connectEventsHandler(fishjamClient) {
+    return new Promise((resolve, reject) => {
+        const onSuccess = () => {
+            clearCallbacks();
+            resolve();
+        };
+        const onError = () => {
+            clearCallbacks();
+            reject();
+        };
+        fishjamClient.on('joined', onSuccess);
+        fishjamClient.on('joinError', onError);
+        fishjamClient.on('authError', onError);
+        fishjamClient.on('socketError', onError);
+        const clearCallbacks = () => {
+            fishjamClient.removeListener('joined', onSuccess);
+            fishjamClient.removeListener('joinError', onError);
+            fishjamClient.removeListener('authError', onError);
+            fishjamClient.removeListener('socketError', onError);
+        };
+    });
+}

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

@@ -15,14 +15,12 @@ export declare class ConnectionManager {
      */
     private getIceServers;
     getConnection: () => RTCPeerConnection;
-    setTransceiversToReadOnly: () => void;
     addTransceiversIfNeeded: (serverTracks: Map<string, number>) => void;
     private getNeededTransceiversTypes;
     addTransceiver: (track: MediaStreamTrack, transceiverConfig: RTCRtpTransceiverInit) => void;
     setOnTrackReady: (onTrackReady: (event: RTCTrackEvent) => void) => void;
     setRemoteDescription: (data: RTCSessionDescriptionInit) => Promise<void>;
     isTrackInUse: (track: MediaStreamTrack) => boolean;
-    setTransceiverDirection: () => void;
     removeTrack: (sender: RTCRtpSender) => void;
     findSender: (mediaStreamTrackId: MediaStreamTrackId) => RTCRtpSender;
     addIceCandidate: (iceCandidate: RTCIceCandidate) => Promise<void>;

package/dist/src/webrtc/ConnectionManager.js

@@ -34,9 +34,6 @@ export class ConnectionManager {
     getConnection = () => {
         return this.connection;
     };
-    setTransceiversToReadOnly = () => {
-        this.connection.getTransceivers().forEach((transceiver) => (transceiver.direction = 'sendonly'));
-    };
     addTransceiversIfNeeded = (serverTracks) => {
         const recvTransceivers = this.connection.getTransceivers().filter((elem) => elem.direction === 'recvonly');
         ['audio', 'video']
@@ -58,14 +55,6 @@ export class ConnectionManager {
         await this.connection.setRemoteDescription(data);
     };
     isTrackInUse = (track) => this.connection.getSenders().some((val) => val.track === track);
-    setTransceiverDirection = () => {
-        this.connection
-            .getTransceivers()
-            .filter((transceiver) => transceiver.direction === 'sendrecv')
-            .forEach((transceiver) => {
-            transceiver.direction = 'sendonly';
-        });
-    };
     removeTrack = (sender) => {
         this.connection.removeTrack(sender);
     };

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

@@ -28,7 +28,6 @@ export declare class Local<EndpointMetadata, TrackMetadata> {
     updateConnection: (connection: ConnectionManager) => void;
     createSdpOfferEvent: (offer: RTCSessionDescriptionInit) => MediaEvent;
     addTrack: (connection: ConnectionManager | undefined, trackId: string, track: MediaStreamTrack, stream: MediaStream, trackMetadata: TrackMetadata | undefined, simulcastConfig: SimulcastConfig, maxBandwidth: TrackBandwidthLimit) => LocalTrack<EndpointMetadata, TrackMetadata>;
-    disableAllLocalTrackEncodings: () => Promise<void>;
     getTrackByMidOrNull: (mid: string) => LocalTrack<EndpointMetadata, TrackMetadata> | null;
     removeTrack: (trackId: TrackId) => void;
     replaceTrack: (webrtc: WebRTCEndpoint<EndpointMetadata, TrackMetadata>, trackId: TrackId, newTrack: MediaStreamTrack | null) => Promise<void>;

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;
@@ -74,16 +80,6 @@ export class Local {
         this.localTracks[trackId] = trackManager;
         return trackManager;
     };
-    disableAllLocalTrackEncodings = async () => {
-        // TODO: Why are we disabling already disabled encodings?
-        //  I think this part of the code is invoked to mutate RTCRtpSender.getParameters().encodings.active.
-        //  We should probably implement a separate method for that, because disabling already disabled tracks seems weird.
-        for (const [trackId, trackManager] of Object.entries(this.localTracks)) {
-            for (const encoding of trackManager.getDisabledEncodings()) {
-                await this.disableLocalTrackEncoding(trackId, encoding);
-            }
-        }
-    };
     getTrackByMidOrNull = (mid) => {
         return Object.values(this.localTracks).find((track) => track.mLineId === mid) ?? null;
     };
@@ -106,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;
@@ -159,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.d.ts

@@ -58,5 +58,5 @@ export declare class LocalTrack<EndpointMetadata, TrackMetadata> implements Trac
     setMLineId: (mLineId: MLineId) => void;
     private isNotSimulcastTrack;
     getTrackBitrates: () => Bitrates;
-    createTrackVariantBitratesEvent: () => import("../mediaEvent").MediaEvent;
+    createTrackVariantBitratesEvent: () => import("..").MediaEvent;
 }

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

@@ -48,7 +48,6 @@ export class LocalTrackManager {
         const trackManager = this.local.addTrack(this.connection, trackId, track, stream, trackMetadata, simulcastConfig, maxBandwidth);
         if (this.connection) {
             trackManager.addTrackToConnection();
-            this.connection.setTransceiverDirection();
         }
         const mediaEvent = generateCustomEvent({ type: 'renegotiateTracks' });
         this.sendMediaEvent(mediaEvent);

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/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

@@ -265,7 +265,6 @@ export class WebRTCEndpoint extends EventEmitter {
         });
         try {
             await this.connectionManager.setRemoteDescription(data);
-            await this.local.disableAllLocalTrackEncodings();
         }
         catch (err) {
             console.error(err);
@@ -626,7 +625,6 @@ export class WebRTCEndpoint extends EventEmitter {
             connection.getConnection().addEventListener('iceconnectionstatechange', onIceConnectionStateChange);
             this.commandsQueue.initConnection(connection);
             this.local.addAllTracksToConnection();
-            connection.setTransceiversToReadOnly();
         }
         this.localTrackManager.updateSenders();
         const tracks = new Map(Object.entries(offerData.data.tracksTypes));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishjam-cloud/ts-client",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "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.46.1",
+    "@playwright/test": "^1.47.2",
     "@types/events": "^3.0.3",
-    "@types/node": "^22.4.1",
+    "@types/node": "^22.7.4",
     "@types/uuid": "^10.0.0",
-    "@vitest/coverage-v8": "^2.0.5",
+    "@vitest/coverage-v8": "^2.1.1",
     "fake-mediastreamtrack": "^1.2.0",
-    "husky": "^9.1.4",
-    "lint-staged": "^15.2.9",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
     "react": "^18.2.0",
-    "ts-proto": "^2.0.2",
+    "ts-proto": "^2.2.1",
     "typed-emitter": "^2.1.0",
-    "typedoc": "^0.26.6",
+    "typedoc": "^0.26.7",
     "typedoc-plugin-external-resolver": "^1.0.3",
-    "typedoc-plugin-mdn-links": "^3.2.10",
-    "typescript": "^5.5.4",
-    "vitest": "^2.0.5",
+    "typedoc-plugin-mdn-links": "^3.3.2",
+    "typescript": "^5.6.2",
+    "vitest": "^2.1.1",
     "zod": "^3.23.6"
   },
   "lint-staged": {