@fishjam-cloud/webrtc-client 0.23.0 → 0.25.0-rc.1

package/dist/index.d.mts

@@ -1,6 +1,11 @@
 import { BinaryWriter, BinaryReader } from '@bufbuild/protobuf/wire';
 import TypedEmitter from 'typed-emitter';
 
+declare const getLogger: (enableLogging: boolean) => {
+    readonly warn: (arg: unknown, ...args: unknown[]) => void;
+    readonly error: (arg: unknown, ...args: unknown[]) => void;
+};
+
 declare enum Variant {
     VARIANT_UNSPECIFIED = 0,
     VARIANT_LOW = 1,
@@ -76,7 +81,7 @@ interface MediaEvent_UpdateTrackMetadata {
     metadataJson: string;
 }
 declare const MediaEvent_UpdateTrackMetadata: MessageFns$1<MediaEvent_UpdateTrackMetadata>;
-/** Sent when peer wants to renegatiate connection due to adding a track or removing a track */
+/** Sent when peer wants to renegotiate connection due to adding a track or removing a track */
 interface MediaEvent_RenegotiateTracks {
 }
 declare const MediaEvent_RenegotiateTracks: MessageFns$1<MediaEvent_RenegotiateTracks>;
@@ -91,7 +96,7 @@ interface MediaEvent_SdpOffer {
     trackIdToMetadataJson: {
         [key: string]: string;
     };
-    /** Maps track_id to its bitrate. The track_id in the TrackBitrates message is ignored (we use the map key), so it can be ommited. */
+    /** Maps track_id to its bitrate. The track_id in the TrackBitrates message is ignored (we use the map key), so it can be omitted. */
     trackIdToBitrates: {
         [key: string]: MediaEvent_TrackBitrates;
     };
@@ -434,6 +439,13 @@ interface Endpoint {
      */
     tracks: Map<string, TrackContext>;
 }
+type WebRTCEndpointProps = {
+    /**
+     * Enables Fishjam SDK's debug logs in the console.
+     */
+    debug?: boolean;
+};
+type Logger = ReturnType<typeof getLogger>;
 
 declare class ConnectionManager {
     private readonly connection;
@@ -482,10 +494,11 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
     private readonly local;
     private readonly commandsQueue;
     private proposedIceServers;
+    private logger;
     bandwidthEstimation: bigint;
     connectionManager?: ConnectionManager;
     private clearConnectionCallbacks;
-    constructor();
+    constructor(props?: WebRTCEndpointProps);
     /**
      * Tries to connect to the RTC Engine. If user is successfully connected then {@link WebRTCEndpointEvents.connected}
      * will be emitted.
@@ -551,10 +564,11 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
      * @param trackMetadata - Any information about this track that other endpoints will
      * receive in {@link WebRTCEndpointEvents.endpointAdded}. E.g. this can source of the track - whether it's
      * screensharing, webcam or some other media device.
-     * @param simulcastConfig - Simulcast configuration. By default simulcast is disabled.
-     * For more information refer to {@link SimulcastConfig}.
-     * @param maxBandwidth - maximal bandwidth this track can use.
-     * Defaults to 0 which is unlimited.
+     * @param _simulcastConfig - Simulcast configuration parameter. **Currently ignored** - simulcast is disabled
+     * regardless of the value passed. This is a temporary change until bandwidth estimation is implemented or
+     * manual track selection support is added. For more information refer to {@link SimulcastConfig}.
+     * @param _maxBandwidth - maximal bandwidth this track can use. **Currently processed with a threshold check**:
+     * if the value is a positive number, it will be used; otherwise, it defaults to 0 (unlimited).
      * This option has no effect for simulcast and audio tracks.
      * For simulcast tracks use `{@link WebRTCEndpoint.setTrackBandwidth}.
      * @returns {string} Returns id of added track
@@ -569,7 +583,7 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
      *     .getTracks()
      *     .forEach((track) => localStream.addTrack(track));
      * } catch (error) {
-     *   console.error("Couldn't get microphone permission:", error);
+     *   this.logger.error("Couldn't get microphone permission:", error);
      * }
      *
      * try {
@@ -580,7 +594,7 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
      *     .getTracks()
      *     .forEach((track) => localStream.addTrack(track));
      * } catch (error) {
-     *  console.error("Couldn't get camera permission:", error);
+     *  this.logger.error("Couldn't get camera permission:", error);
      * }
      *
      * localStream
@@ -588,7 +602,7 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
      *  .forEach((track) => webrtc.addTrack(track, localStream));
      * ```
      */
-    addTrack(track: MediaStreamTrack, trackMetadata?: unknown, simulcastConfig?: MediaEvent_Track_SimulcastConfig, maxBandwidth?: TrackBandwidthLimit): Promise<string>;
+    addTrack(track: MediaStreamTrack, trackMetadata?: unknown, _simulcastConfig?: MediaEvent_Track_SimulcastConfig, _maxBandwidth?: TrackBandwidthLimit): Promise<string>;
     /**
      * Replaces a track that is being sent to the RTC Engine.
      * @param trackId - Audio or video track.
@@ -607,7 +621,7 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
      *     .getTracks()
      *     .forEach((track) => localStream.addTrack(track));
      * } catch (error) {
-     *   console.error("Couldn't get camera permission:", error);
+     *   this.logger.error("Couldn't get camera permission:", error);
      * }
      * let oldTrackId;
      * localStream
@@ -630,7 +644,7 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
      *     webrtc.replaceTrack(oldTrackId, videoTrack);
      *   })
      *   .catch((error) => {
-     *     console.error('Error switching camera', error);
+     *     this.logger.error('Error switching camera', error);
      *   })
      * ```
      */
@@ -669,7 +683,7 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
      *     .getTracks()
      *     .forEach((track) => localStream.addTrack(track));
      * } catch (error) {
-     *   console.error("Couldn't get camera permission:", error);
+     *   this.logger.error("Couldn't get camera permission:", error);
      * }
      *
      * let trackId
@@ -763,4 +777,4 @@ declare class WebRTCEndpoint extends WebRTCEndpoint_base {
     private onIceConnectionStateChange;
 }
 
-export { type BandwidthLimit, type EncodingReason, type Endpoint, type MediaEvent, type SerializedMediaEvent, type SimulcastBandwidthLimit, MediaEvent_Track_SimulcastConfig as SimulcastConfig, type TrackBandwidthLimit, type TrackContext, type TrackContextEvents, type TrackKind, type VadStatus, Variant, WebRTCEndpoint, type WebRTCEndpointEvents };
+export { type BandwidthLimit, type EncodingReason, type Endpoint, type Logger, type MediaEvent, type SerializedMediaEvent, type SimulcastBandwidthLimit, MediaEvent_Track_SimulcastConfig as SimulcastConfig, type TrackBandwidthLimit, type TrackContext, type TrackContextEvents, type TrackKind, type VadStatus, Variant, WebRTCEndpoint, type WebRTCEndpointEvents, getLogger };

package/dist/index.mjs

@@ -1,3 +1,14 @@
+// src/logger.ts
+var FISHJAM_PREFIX = "[FISHJAM]";
+var getLogger = (enableLogging) => ({
+  warn: (arg, ...args) => {
+    if (enableLogging) console.warn(FISHJAM_PREFIX, arg, ...args);
+  },
+  error: (arg, ...args) => {
+    if (enableLogging) console.error(FISHJAM_PREFIX, arg, ...args);
+  }
+});
+
 // ../protobufs/fishjam/media_events/peer/peer.ts
 import { BinaryReader as BinaryReader2, BinaryWriter as BinaryWriter2 } from "@bufbuild/protobuf/wire";
 
@@ -4417,11 +4428,13 @@ var WebRTCEndpoint = class extends EventEmitter2 {
   local;
   commandsQueue;
   proposedIceServers = [];
+  logger;
   bandwidthEstimation = BigInt(0);
   connectionManager;
   clearConnectionCallbacks = null;
-  constructor() {
+  constructor(props = {}) {
     super();
+    this.logger = getLogger(!!props.debug);
     const sendEvent = (mediaEvent) => this.sendMediaEvent(mediaEvent);
     const emit = (events, ...args) => {
       this.emit(events, ...args);
@@ -4575,7 +4588,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
       const { trackId, status } = event.vadNotification;
       this.remote.setRemoteTrackVadStatus(trackId, status);
     } else if (event.error) {
-      console.warn("signaling error", {
+      this.logger.warn("signaling error", {
         message: event.error.message
       });
       this.emit("signalingError", {
@@ -4618,7 +4631,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
     try {
       await this.connectionManager.setRemoteDescription({ sdp: data.sdp, type: "answer" });
     } catch (err) {
-      console.error(err);
+      this.logger.error(err);
     }
   };
   /**
@@ -4627,10 +4640,11 @@ var WebRTCEndpoint = class extends EventEmitter2 {
    * @param trackMetadata - Any information about this track that other endpoints will
    * receive in {@link WebRTCEndpointEvents.endpointAdded}. E.g. this can source of the track - whether it's
    * screensharing, webcam or some other media device.
-   * @param simulcastConfig - Simulcast configuration. By default simulcast is disabled.
-   * For more information refer to {@link SimulcastConfig}.
-   * @param maxBandwidth - maximal bandwidth this track can use.
-   * Defaults to 0 which is unlimited.
+   * @param _simulcastConfig - Simulcast configuration parameter. **Currently ignored** - simulcast is disabled
+   * regardless of the value passed. This is a temporary change until bandwidth estimation is implemented or
+   * manual track selection support is added. For more information refer to {@link SimulcastConfig}.
+   * @param _maxBandwidth - maximal bandwidth this track can use. **Currently processed with a threshold check**:
+   * if the value is a positive number, it will be used; otherwise, it defaults to 0 (unlimited).
    * This option has no effect for simulcast and audio tracks.
    * For simulcast tracks use `{@link WebRTCEndpoint.setTrackBandwidth}.
    * @returns {string} Returns id of added track
@@ -4645,7 +4659,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
    *     .getTracks()
    *     .forEach((track) => localStream.addTrack(track));
    * } catch (error) {
-   *   console.error("Couldn't get microphone permission:", error);
+   *   this.logger.error("Couldn't get microphone permission:", error);
    * }
    *
    * try {
@@ -4656,7 +4670,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
    *     .getTracks()
    *     .forEach((track) => localStream.addTrack(track));
    * } catch (error) {
-   *  console.error("Couldn't get camera permission:", error);
+   *  this.logger.error("Couldn't get camera permission:", error);
    * }
    *
    * localStream
@@ -4664,14 +4678,20 @@ var WebRTCEndpoint = class extends EventEmitter2 {
    *  .forEach((track) => webrtc.addTrack(track, localStream));
    * ```
    */
-  async addTrack(track, trackMetadata, simulcastConfig = {
+  async addTrack(track, trackMetadata, _simulcastConfig = {
     enabled: false,
     enabledVariants: [],
     disabledVariants: []
-  }, maxBandwidth = 0) {
+  }, _maxBandwidth = 0) {
     const resolutionNotifier = new Deferred();
     const trackId = this.getTrackId(uuidv4());
     const stream = new MediaStream();
+    const simulcastConfig = {
+      enabled: false,
+      enabledVariants: [],
+      disabledVariants: []
+    };
+    const maxBandwidth = typeof _maxBandwidth === "number" && _maxBandwidth > 0 ? _maxBandwidth : 0;
     try {
       stream.addTrack(track);
       this.commandsQueue.pushCommand({
@@ -4712,7 +4732,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
    *     .getTracks()
    *     .forEach((track) => localStream.addTrack(track));
    * } catch (error) {
-   *   console.error("Couldn't get camera permission:", error);
+   *   this.logger.error("Couldn't get camera permission:", error);
    * }
    * let oldTrackId;
    * localStream
@@ -4735,7 +4755,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
    *     webrtc.replaceTrack(oldTrackId, videoTrack);
    *   })
    *   .catch((error) => {
-   *     console.error('Error switching camera', error);
+   *     this.logger.error('Error switching camera', error);
    *   })
    * ```
    */
@@ -4790,7 +4810,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
    *     .getTracks()
    *     .forEach((track) => localStream.addTrack(track));
    * } catch (error) {
-   *   console.error("Couldn't get camera permission:", error);
+   *   this.logger.error("Couldn't get camera permission:", error);
    * }
    *
    * let trackId
@@ -4918,19 +4938,19 @@ var WebRTCEndpoint = class extends EventEmitter2 {
       this.localTrackManager.updateSenders();
       const offer = await connection.getConnection().createOffer();
       if (!this.connectionManager) {
-        console.warn("RTCPeerConnection stopped or restarted");
+        this.logger.warn("RTCPeerConnection stopped or restarted");
         return;
       }
       await connection.getConnection().setLocalDescription(offer);
       if (!this.connectionManager) {
-        console.warn("RTCPeerConnection stopped or restarted");
+        this.logger.warn("RTCPeerConnection stopped or restarted");
         return;
       }
       const sdpOffer = this.local.createSdpOfferEvent(offer);
       this.sendMediaEvent({ sdpOffer });
       this.local.setLocalTrackStatusToOffered();
     } catch (error) {
-      console.error(error);
+      this.logger.error(error);
     }
   }
   onOfferData = async (offerData) => {
@@ -4974,7 +4994,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
       }
       await this.connectionManager.addIceCandidate(iceCandidate);
     } catch (error) {
-      console.error(error);
+      this.logger.error(error);
     }
   };
   onLocalCandidate = (event) => {
@@ -4988,7 +5008,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
     this.sendMediaEvent({ candidate });
   };
   onIceCandidateError = (event) => {
-    console.warn(event);
+    this.logger.warn(event);
   };
   onConnectionStateChange = (event) => {
     switch (this.localTrackManager.connection?.getConnection().connectionState) {
@@ -5003,7 +5023,7 @@ var WebRTCEndpoint = class extends EventEmitter2 {
   onIceConnectionStateChange = (event) => {
     switch (this.localTrackManager.connection?.getConnection().iceConnectionState) {
       case "disconnected":
-        console.warn("ICE connection: disconnected");
+        this.logger.warn("ICE connection: disconnected");
         this.sendMediaEvent({ renegotiateTracks: MediaEvent_RenegotiateTracks.create() });
         break;
       case "failed":
@@ -5018,5 +5038,6 @@ var WebRTCEndpoint = class extends EventEmitter2 {
 export {
   MediaEvent_Track_SimulcastConfig as SimulcastConfig,
   Variant,
-  WebRTCEndpoint
+  WebRTCEndpoint,
+  getLogger
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fishjam-cloud/webrtc-client",
-  "version": "0.23.0",
+  "version": "0.25.0-rc.1",
   "description": "Typescript client library for ExWebRTC/WebRTC endpoint in Membrane RTC Engine",
   "license": "Apache-2.0",
   "author": "Fishjam Team",
@@ -70,10 +70,11 @@
   },
   "lint-staged": {
     "*": [
-      "yarn format:check"
+      "yarn format"
     ],
     "*.(js|ts|tsx)": [
-      "yarn lint:check"
+      "yarn lint"
     ]
-  }
+  },
+  "stableVersion": "0.24.0"
 }