fix js-doc

src/livekit/openIDSFU.ts

@@ -67,7 +67,7 @@ export type OpenIDClientParts = Pick<
  * to the matrix RTC backend in order to get acces to the SFU.
  * It has built-in retry for calls to the homeserver with a backoff policy.
  * @param client The Matrix client
- * @param membership
+ * @param membership Our own membership identity parts used to send to jwt service.
  * @param serviceUrl The URL of the livekit SFU service
  * @param forceOldJwtEndpoint This will use the old jwt endpoint which will create the rtc backend identity based on string concatination
  * instead of a hash.
@@ -75,9 +75,9 @@ export type OpenIDClientParts = Pick<
  * For remote connections this does not matter, since we will not publish there we can rely on the newest option.
  * For our own connection we can only use the hashed version if we also send the new matrix2.0 sticky events.
  * @param roomId The room id used in the jwt request. This is NOT the livekit_alias. The jwt service will provide the alias. It maps matrix room ids <-> Livekit aliases.
- * @param delayEndpointBaseUrl
- * @param delayId
- * @param logger
+ * @param delayEndpointBaseUrl The URL of the matrix homeserver.
+ * @param delayId The delay id used for the jwt service to manage.
+ * @param logger optional logger.
  * @returns Object containing the token information
  * @throws FailToGetOpenIdToken
  */

src/state/CallViewModel/localMember/LocalMember.ts

@@ -687,10 +687,9 @@ interface EnterRTCSessionOptions {
  *      - Handles retries (fails only after several attempts)
  *
  * @param rtcSession - The MatrixRTCSession to join.
+ * @param ownMembershipIdentity - Options for entering the RTC session.
  * @param transport - The LivekitTransport to use for this session.
- * @param options - Options for entering the RTC session.
- * @param options.encryptMedia - Whether to encrypt media.
- * @param options.matrixRTCMode - The Matrix RTC mode to use.
+ * @param options - `encryptMedia`: Whether to encrypt media `matrixRTCMode`: The Matrix RTC mode to use.
  * @throws If the widget could not send ElementWidgetActions.JoinCall action.
  */
 // Exported for unit testing
@@ -698,8 +697,9 @@ export function enterRTCSession(
   rtcSession: MatrixRTCSession,
   ownMembershipIdentity: CallMembershipIdentityParts,
   transport: LivekitTransport,
-  { encryptMedia, matrixRTCMode }: EnterRTCSessionOptions,
+  options: EnterRTCSessionOptions,
 ): void {
+  const { encryptMedia, matrixRTCMode } = options;
   PosthogAnalytics.instance.eventCallEnded.cacheStartCall(new Date());
   PosthogAnalytics.instance.eventCallStarted.track(rtcSession.room.roomId);
 

src/state/CallViewModel/localMember/LocalTransport.ts

@@ -159,10 +159,12 @@ const FOCI_WK_KEY = "org.matrix.msc4143.rtc_foci";
  * 4. The transport configured in Element Call's config.
  *
  * @param client The authenticated Matrix client for the current user
+ * @param membership The membership identity of the user.
  * @param roomId The ID of the room to be connected to.
  * @param urlFromDevSettings Override URL provided by the user's local config.
- * @param useMatrix2 This implies using the matrix2 jwt endpoint (including delayed event delegation of the jwt token)
- * @param delayId
+ * @param forceOldJwtEndpoint Whether to force the old JWT endpoint (not hashing the backendIdentity).
+ * @param delayId the delay id passed to the jwt service.
+ *
  * @returns A fully validated transport config.
  * @throws MatrixRTCTransportMissingError | FailToGetOpenIdToken
  */

src/state/CallViewModel/remoteMembers/ConnectionFactory.ts

@@ -31,8 +31,8 @@ export interface ConnectionFactory {
   createConnection(
     transport: LivekitTransport,
     scope: ObservableScope,
-    logger: Logger,
     ownMembershipIdentity: CallMembershipIdentityParts,
+    logger: Logger,
     forceOldJwtEndpoint?: boolean,
   ): Connection;
 }
@@ -83,17 +83,18 @@ export class ECConnectionFactory implements ConnectionFactory {
 
   /**
    *
-   * @param transport
-   * @param scope
-   * @param logger
+   * @param transport The transport to use for this connection.
+   * @param scope The observable scope (used for clean-up)
    * @param ownMembershipIdentity required to connect (using the jwt service) with the SFU.
+   * @param logger The logger instance to use for this connection.
+   * @param forceOldJwtEndpoint Use the old JWT endpoint independent of what the sfu supports.
    * @returns
    */
   public createConnection(
     transport: LivekitTransport,
     scope: ObservableScope,
-    logger: Logger,
     ownMembershipIdentity: CallMembershipIdentityParts,
+    logger: Logger,
     forceOldJwtEndpoint?: boolean,
   ): Connection {
     return new Connection(

src/state/CallViewModel/remoteMembers/ConnectionManager.ts

@@ -83,8 +83,12 @@ export interface IConnectionManager {
  * @param props - Configuration object
  * @param props.scope - The observable scope used by this object
  * @param props.connectionFactory - Used to create new connections
- * @param props.inputTransports$ - A list of Behaviors each containing a LIST of LivekitTransport.
- * @param props.logger - The logger to use
+ * @param props.localTransport$ - The local transport to use. (deduplicated with remoteTransports$)
+ * @param props.remoteTransports$ - All other transports. The connection manager will create connections for each transport. (deduplicated with localTransport$)
+ * @param props.ownMembershipIdentity - The own membership identity to use.
+ * @param props.logger - The logger to use.
+ * @param props.forceOldJwtEndpointForLocalTransport$ - Use the old JWT endpoint independent of what the sfu supports. Only applies for localTransport$.
+ *
  *   Each of these behaviors can be interpreted as subscribed list of transports.
  *
  *   Using `registerTransports` independent external modules can control what connections
@@ -183,8 +187,8 @@ export function createConnectionManager$({
               livekit_alias: alias,
             },
             scope,
-            logger,
             ownMembershipIdentity,
+            logger,
             forceOldJwtEndpoint,
           );
           // Start the connection immediately

src/state/CallViewModel/remoteMembers/ECConnectionFactory.test.ts

@@ -79,8 +79,8 @@ describe("ECConnectionFactory - Audio inputs options", () => {
       ecConnectionFactory.createConnection(
         exampleTransport,
         testScope,
-        logger,
         ownMemberMock,
+        logger,
       );
 
       // Check if Room was constructed with expected options
@@ -125,8 +125,8 @@ describe("ECConnectionFactory - ControlledAudioDevice", () => {
       ecConnectionFactory.createConnection(
         exampleTransport,
         testScope,
-        logger,
         ownMemberMock,
+        logger,
       );
 
       // Check if Room was constructed with expected options