mediasfu-shared 1.0.2 → 1.0.4

package/README.md

@@ -1,103 +1,108 @@
-# mediasfu-shared
-
-`mediasfu-shared` is the framework-agnostic MediaSFU runtime package. It exposes the shared room helpers, mediasoup/socket flows, state utilities, and TypeScript types used by the MediaSFU SDK family.
-
-## When To Use This Package
-
-Use `mediasfu-shared` when you want to:
-
-- build your own browser client on top of MediaSFU primitives without adopting a framework-specific UI package
-- share MediaSFU room, media, and participant logic across React, Vue, Angular, Svelte, or plain TypeScript codebases
-- import low-level helpers such as `createRoomOnMediaSFU`, `joinRoomOnMediaSFU`, `connectSocket`, `SocketManager`, and the exported consumers, methods, and types entry points
-
-## Installation
-
-```bash
-npm install mediasfu-shared mediasoup-client socket.io-client
-```
-
-`mediasoup-client` and `socket.io-client` are peer dependencies, so install them in the host app.
-
-## Backend Requirement
-
-The cloud room helpers in this package target `https://mediasfu.com/v1/rooms/` by default.
-
-- Use MediaSFU Cloud when you want managed room creation, signaling, and media routing. Pass `apiUserName` and `apiKey`.
-- Use MediaSFU Open / Community Edition when you self-host. Pass a non-MediaSFU `localLink` such as `http://localhost:3000`.
-
-## Quick Example
-
-```ts
-import {
-  SocketManager,
-  connectSocket,
-  createRoomOnMediaSFU,
-  joinRoomOnMediaSFU,
-} from 'mediasfu-shared';
-
-const createResult = await createRoomOnMediaSFU({
-  payload: {
-    action: 'create',
-    userName: 'Ada',
-    duration: 60,
-    capacity: 10,
-  },
-  apiUserName: 'your-api-username',
-  apiKey: 'your-64-character-api-key',
-});
-
-const joinResult = await joinRoomOnMediaSFU({
-  payload: {
-    action: 'join',
-    meetingID: 'room123',
-    userName: 'Ben',
-  },
-  apiUserName: 'your-api-username',
-  apiKey: 'your-64-character-api-key',
-});
-
-const socket = await connectSocket({
-  apiUserName: 'your-api-username',
-  apiKey: 'your-64-character-api-key',
-  apiToken: 'your-api-token',
-  link: 'https://mediasfu.com/socket',
-});
-
-const socketManager = new SocketManager({ socket });
-
-console.log(createResult.success, joinResult.success, socketManager.socket.connected);
-```
-
-## Import Paths
-
-- `mediasfu-shared` exposes the full public runtime surface.
-- `mediasfu-shared/consumers` is useful when you want consumer/grid helpers only.
-- `mediasfu-shared/methods` is useful when you want action utilities and room helpers.
-- `mediasfu-shared/types` is useful when you only need TypeScript contracts.
-
-## Documentation
-
-- Main docs: [https://mediasfu.com/documentation](https://mediasfu.com/documentation)
-- User guide: [https://mediasfu.com/user-guide](https://mediasfu.com/user-guide)
-- MediaSFU Open / CE: [https://github.com/MediaSFU/MediaSFUOpen](https://github.com/MediaSFU/MediaSFUOpen)
-
-Generate package-local API docs with:
-
-```bash
-npm run build-docs
-```
-
-## Related Packages
-
-- [mediasfu-reactjs](https://www.npmjs.com/package/mediasfu-reactjs)
-- [mediasfu-vue](https://www.npmjs.com/package/mediasfu-vue)
-- [mediasfu-angular](https://www.npmjs.com/package/mediasfu-angular)
-
-## Support
-
-- GitHub issues: [https://github.com/MediaSFU/MediaSFU-Shared/issues](https://github.com/MediaSFU/MediaSFU-Shared/issues)
-- Email: info@mediasfu.com
-
-## License
-
-MIT. See [LICENSE](LICENSE).
+# mediasfu-shared · [mediasfu-shared on npm](https://www.npmjs.com/package/mediasfu-shared)
+
+**mediasfu-shared** is the framework-agnostic WebRTC runtime at the core of the MediaSFU SDK family. It provides shared room helpers, mediasoup signaling, socket management, media state utilities, and TypeScript types for React, Vue, Angular, Svelte, and plain TypeScript. Install with `npm install mediasfu-shared`.
+
+`mediasfu-shared` is the framework-agnostic MediaSFU runtime package. It exposes the shared room helpers, mediasoup/socket flows, state utilities, and TypeScript types used by the MediaSFU SDK family.
+
+## When To Use This Package
+
+Use `mediasfu-shared` when you want to:
+
+- build your own browser client on top of MediaSFU primitives without adopting a framework-specific UI package
+- share MediaSFU room, media, and participant logic across React, Vue, Angular, Svelte, or plain TypeScript codebases
+- import low-level helpers such as `createRoomOnMediaSFU`, `joinRoomOnMediaSFU`, `connectSocket`, `SocketManager`, and the exported consumers, methods, and types entry points
+
+## Installation
+
+```bash
+npm install mediasfu-shared mediasoup-client socket.io-client
+```
+
+`mediasoup-client` and `socket.io-client` are peer dependencies, so install them in the host app.
+
+## Backend Requirement
+
+The cloud room helpers in this package target `https://mediasfu.com/v1/rooms/` by default.
+
+- Use MediaSFU Cloud when you want managed room creation, signaling, and media routing. Pass `apiUserName` and `apiKey`.
+- Use MediaSFU Open / Community Edition when you self-host. Pass a non-MediaSFU `localLink` such as `http://localhost:3000`.
+
+## Quick Example
+
+```ts
+import {
+  SocketManager,
+  connectSocket,
+  createRoomOnMediaSFU,
+  joinRoomOnMediaSFU,
+} from 'mediasfu-shared';
+
+const createResult = await createRoomOnMediaSFU({
+  payload: {
+    action: 'create',
+    userName: 'Ada',
+    duration: 60,
+    capacity: 10,
+  },
+  apiUserName: 'your-api-username',
+  apiKey: 'your-64-character-api-key',
+});
+
+const joinResult = await joinRoomOnMediaSFU({
+  payload: {
+    action: 'join',
+    meetingID: 'room123',
+    userName: 'Ben',
+  },
+  apiUserName: 'your-api-username',
+  apiKey: 'your-64-character-api-key',
+});
+
+const socket = await connectSocket({
+  apiUserName: 'your-api-username',
+  apiKey: 'your-64-character-api-key',
+  apiToken: 'your-api-token',
+  link: 'https://mediasfu.com/socket',
+});
+
+const socketManager = new SocketManager({ socket });
+
+console.log(createResult.success, joinResult.success, socketManager.socket.connected);
+```
+
+## Import Paths
+
+- `mediasfu-shared` exposes the full public runtime surface.
+- `mediasfu-shared/consumers` is useful when you want consumer/grid helpers only.
+- `mediasfu-shared/methods` is useful when you want action utilities and room helpers.
+- `mediasfu-shared/types` is useful when you only need TypeScript contracts.
+
+## Documentation
+
+- Main docs: [https://mediasfu.com/documentation](https://mediasfu.com/documentation)
+- User guide: [https://mediasfu.com/user-guide](https://mediasfu.com/user-guide)
+- MediaSFU Open / CE: [https://github.com/MediaSFU/MediaSFUOpen](https://github.com/MediaSFU/MediaSFUOpen)
+
+Generate package-local API docs with:
+
+```bash
+npm run build-docs
+```
+
+## Related Packages
+
+| Package | Framework | npm |
+|---------|-----------|-----|
+| [mediasfu-reactjs](https://github.com/MediaSFU/MediaSFU-ReactJS) | React 18/19 | [`npm install mediasfu-reactjs`](https://www.npmjs.com/package/mediasfu-reactjs) |
+| [mediasfu-vue](https://github.com/MediaSFU/MediaSFU-Vue) | Vue 3 / Composition API | [`npm install mediasfu-vue`](https://www.npmjs.com/package/mediasfu-vue) |
+| [mediasfu-angular](https://github.com/MediaSFU/MediaSFU-Angular) | Angular 17/18/19 | [`npm install mediasfu-angular`](https://www.npmjs.com/package/mediasfu-angular) |
+| [mediasfu-reactnative](https://www.npmjs.com/package/mediasfu-reactnative) | React Native | [`npm install mediasfu-reactnative`](https://www.npmjs.com/package/mediasfu-reactnative) |
+
+## Support
+
+- GitHub issues: [https://github.com/MediaSFU/MediaSFU-Shared/issues](https://github.com/MediaSFU/MediaSFU-Shared/issues)
+- Email: info@mediasfu.com
+
+## License
+
+MIT. See [LICENSE](LICENSE).

package/dist/index.cjs

@@ -1260,13 +1260,15 @@ const connectIps = async ({
             roomRecvIPs.push(ip);
             updateRoomRecvIPs(roomRecvIPs);
           }
-          remote_sock.on("new-pipe-producer", async ({ producerId, islevel }) => {
+          remote_sock.on("new-pipe-producer", async ({ producerId, islevel, isTranslation, translationMeta }) => {
             if (newProducerMethod) {
               await newProducerMethod({
                 producerId,
                 islevel,
                 nsock: remote_sock,
-                parameters
+                parameters,
+                isTranslation,
+                translationMeta
               });
             }
           });
@@ -1307,13 +1309,15 @@ const connectLocalIps = async ({
   parameters
 }) => {
   try {
-    socket.on("new-producer", async ({ producerId, islevel }) => {
+    socket.on("new-producer", async ({ producerId, islevel, isTranslation, translationMeta }) => {
       if (newProducerMethod) {
         await newProducerMethod({
           producerId,
           islevel,
           nsock: socket,
-          parameters
+          parameters,
+          isTranslation,
+          translationMeta
         });
       }
     });
@@ -1327,6 +1331,47 @@ const connectLocalIps = async ({
     console.log("ConnectLocalIps error", error);
   }
 };
+const getSpeakerNameForProducerId$1 = (producerId, parameters) => {
+  const participants = parameters.participants;
+  const participant = participants?.find((candidate) => candidate.audioID === producerId);
+  if (participant?.name) {
+    return participant.name;
+  }
+  const audStreamName = parameters.audStreamNames?.find((stream) => stream.producerId === producerId && typeof stream.name === "string");
+  if (audStreamName?.name) {
+    return audStreamName.name;
+  }
+  return parameters.allAudioStreams?.find((stream) => stream.producerId === producerId && typeof stream.name === "string")?.name;
+};
+const isOriginalAudioSuppressedByTranslation$1 = (producerId, parameters) => {
+  const activeTranslationProducerIds = parameters.activeTranslationProducerIds;
+  if (activeTranslationProducerIds?.has(producerId)) {
+    return false;
+  }
+  const speakerTranslationStates = parameters.speakerTranslationStates;
+  if (!speakerTranslationStates?.size) {
+    return false;
+  }
+  const speakerName = getSpeakerNameForProducerId$1(producerId, parameters);
+  if (speakerName) {
+    const speakerState = speakerTranslationStates.get(speakerName);
+    if (speakerState?.enabled) {
+      return true;
+    }
+  }
+  return Array.from(speakerTranslationStates.values()).some((speakerState) => {
+    if (!speakerState?.enabled) {
+      return false;
+    }
+    if (speakerState.originalProducerId === producerId) {
+      return true;
+    }
+    if (!speakerName) {
+      return false;
+    }
+    return speakerState.speakerId === speakerName || speakerState.speakerName === speakerName;
+  });
+};
 const connectRecvTransport = async ({
   consumerTransport,
   remoteProducerId,
@@ -1388,24 +1433,15 @@ const connectRecvTransport = async ({
                   if (params.kind === "audio") {
                     try {
                       const updatedParams = parameters.getUpdatedAllParams();
-                      const speakerTranslationStates = updatedParams.speakerTranslationStates;
-                      const participants = updatedParams.participants;
-                      if (speakerTranslationStates && speakerTranslationStates.size > 0 && participants?.length) {
-                        const participant = participants.find(
-                          (candidate) => candidate.audioID === remoteProducerId
-                        );
-                        if (participant?.name) {
-                          const speakerState = speakerTranslationStates.get(participant.name);
-                          if (speakerState?.enabled && speakerState.originalProducerId === remoteProducerId) {
-                            consumer.pause();
-                            nsock.emit(
-                              "consumer-pause",
-                              { serverConsumerId: params.serverConsumerId },
-                              () => {
-                              }
-                            );
+                      if (isOriginalAudioSuppressedByTranslation$1(remoteProducerId, updatedParams)) {
+                        consumer.pause();
+                        nsock.emit(
+                          "consumer-pause",
+                          { serverConsumerId: params.serverConsumerId },
+                          () => {
                           }
-                        }
+                        );
+                        return;
                       }
                     } catch {
                     }
@@ -2666,6 +2702,50 @@ async function processConsumerTransports({
 const getProducerId$1 = (value) => {
   return value?.producerId;
 };
+const getSpeakerNameForProducerId = (producerId, parameters) => {
+  const participants = parameters.participants;
+  const participant = participants?.find((candidate) => candidate.audioID === producerId);
+  if (participant?.name) {
+    return participant.name;
+  }
+  const audStreamName = parameters.audStreamNames?.find((stream) => stream.producerId === producerId && typeof stream.name === "string");
+  if (audStreamName?.name) {
+    return audStreamName.name;
+  }
+  return parameters.allAudioStreams?.find((stream) => stream.producerId === producerId && typeof stream.name === "string")?.name;
+};
+const isOriginalAudioSuppressedByTranslation = (producerId, parameters) => {
+  if (!producerId) {
+    return false;
+  }
+  const activeTranslationProducerIds = parameters.activeTranslationProducerIds;
+  if (activeTranslationProducerIds?.has(producerId)) {
+    return false;
+  }
+  const speakerTranslationStates = parameters.speakerTranslationStates;
+  if (!speakerTranslationStates?.size) {
+    return false;
+  }
+  const speakerName = getSpeakerNameForProducerId(producerId, parameters);
+  if (speakerName) {
+    const speakerState = speakerTranslationStates.get(speakerName);
+    if (speakerState?.enabled) {
+      return true;
+    }
+  }
+  return Array.from(speakerTranslationStates.values()).some((speakerState) => {
+    if (!speakerState?.enabled) {
+      return false;
+    }
+    if (speakerState.originalProducerId === producerId) {
+      return true;
+    }
+    if (!speakerName) {
+      return false;
+    }
+    return speakerState.speakerId === speakerName || speakerState.speakerName === speakerName;
+  });
+};
 const processConsumerTransportsAudio = async ({
   consumerTransports,
   lStreams,
@@ -2679,12 +2759,12 @@ const processConsumerTransportsAudio = async ({
       });
     };
     const consumerTransportsToResume = consumerTransports.filter(
-      (transport) => isValidProducerId(transport.producerId, lStreams) && transport.consumer?.paused === true && transport.consumer?.kind === "audio"
+      (transport) => isValidProducerId(transport.producerId, lStreams) && !isOriginalAudioSuppressedByTranslation(transport.producerId, parameters) && transport.consumer?.paused === true && transport.consumer?.kind === "audio"
     );
     const consumerTransportsToPause = consumerTransports.filter(
-      (transport) => transport.producerId && transport.producerId !== null && transport.producerId !== "" && !lStreams.some(
+      (transport) => transport.producerId && transport.producerId !== null && transport.producerId !== "" && (isOriginalAudioSuppressedByTranslation(transport.producerId, parameters) || !lStreams.some(
         (stream) => getProducerId$1(stream) === transport.producerId
-      ) && transport.consumer && transport.consumer?.kind && transport.consumer.paused !== true && transport.consumer.kind === "audio"
+      )) && transport.consumer && transport.consumer?.kind && transport.consumer.paused !== true && transport.consumer.kind === "audio"
     );
     await sleep2({ ms: 100 });
     for (const transport of consumerTransportsToPause) {
@@ -2697,6 +2777,9 @@ const processConsumerTransportsAudio = async ({
       );
     }
     for (const transport of consumerTransportsToResume) {
+      if (isOriginalAudioSuppressedByTranslation(transport.producerId, parameters)) {
+        continue;
+      }
       transport.socket_.emit(
         "consumer-resume",
         { serverConsumerId: transport.serverConsumerTransportId },
@@ -4152,7 +4235,9 @@ const clickVideo = async ({ parameters }) => {
         audioSetting,
         videoSetting,
         screenshareSetting,
-        chatSetting
+        chatSetting,
+        permissionConfig: parameters.permissionConfig,
+        participantLevel: islevel
       });
     } else {
       response = 0;
@@ -5307,11 +5392,17 @@ const hostRequestResponse = async ({
   updateChatRequestTime,
   updateRequestIntervalSeconds
 }) => {
+  const requestType = requestResponse.type ?? requestResponse.icon;
   const filteredRequests = requestList.filter(
-    (request) => request.id !== requestResponse.id && request.icon !== requestResponse.type && request.name !== requestResponse.name && request.username !== requestResponse.username
+    (request) => {
+      const matchesId = request.id === requestResponse.id;
+      const matchesType = requestType == null || request.icon === requestType;
+      const matchesName = requestResponse.name == null || request.name === requestResponse.name;
+      const matchesUsername = requestResponse.username == null || request.username === requestResponse.username;
+      return !(matchesId && matchesType && matchesName && matchesUsername);
+    }
   );
   updateRequestList(filteredRequests);
-  const requestType = requestResponse.type;
   if (requestResponse.action === "accepted") {
     switch (requestType) {
       case "fa-microphone":
@@ -6277,11 +6368,20 @@ const updateRoomParametersClient = ({ parameters }) => {
   }
 };
 const DEFAULT_MEDIA_SFU_ROOM_API_URL = "https://mediasfu.com/v1/rooms/";
+const normalizeManagedRoomApi = (normalizedLink) => {
+  if (normalizedLink.includes("/v1/rooms")) {
+    return `${normalizedLink.replace(/\/$/, "")}/`;
+  }
+  return `${normalizedLink.replace(/\/$/, "")}/v1/rooms/`;
+};
 const resolveMediaSFURoomApi = (localLink, action) => {
   const normalizedLink = localLink?.trim();
-  if (!normalizedLink || normalizedLink.includes("mediasfu.com")) {
+  if (!normalizedLink) {
     return DEFAULT_MEDIA_SFU_ROOM_API_URL;
   }
+  if (normalizedLink.includes("mediasfu.com")) {
+    return normalizeManagedRoomApi(normalizedLink);
+  }
   return `${normalizedLink.replace(/\/$/, "")}/${action}`;
 };
 const readResponseError$1 = async (response) => {
@@ -7355,15 +7455,22 @@ const pauseOriginalProducer = async ({
     const transport = consumerTransports.find(
       (t) => t.producerId === originalProducerId && t.consumer?.kind === "audio"
     );
-    if (transport && transport.consumer && !transport.consumer.paused) {
-      transport.consumer.pause();
-      transport.socket_?.emit(
-        "consumer-pause",
-        { serverConsumerId: transport.serverConsumerTransportId },
-        async () => {
-        }
-      );
+    if (!transport?.consumer) {
+      return;
+    }
+    if (transport.consumer.track) {
+      transport.consumer.track.enabled = false;
+    }
+    if (transport.consumer.paused) {
+      return;
     }
+    transport.consumer.pause();
+    transport.socket_?.emit(
+      "consumer-pause",
+      { serverConsumerId: transport.serverConsumerTransportId },
+      async () => {
+      }
+    );
   } catch (error) {
     console.error("[TranslationSwitch] Error pausing original producer:", error);
   }
@@ -7381,17 +7488,27 @@ const resumeOriginalProducer = async ({
     const transport = consumerTransports.find(
       (t) => t.producerId === originalProducerId && t.consumer?.kind === "audio"
     );
-    if (transport && transport.consumer && transport.consumer.paused) {
-      transport.socket_?.emit(
-        "consumer-resume",
-        { serverConsumerId: transport.serverConsumerTransportId },
-        async ({ resumed }) => {
-          if (resumed) {
-            transport.consumer.resume();
+    if (!transport?.consumer) {
+      return;
+    }
+    if (!transport.consumer.paused) {
+      if (transport.consumer.track) {
+        transport.consumer.track.enabled = true;
+      }
+      return;
+    }
+    transport.socket_?.emit(
+      "consumer-resume",
+      { serverConsumerId: transport.serverConsumerTransportId },
+      async ({ resumed }) => {
+        if (resumed) {
+          if (transport.consumer.track) {
+            transport.consumer.track.enabled = true;
           }
+          transport.consumer.resume();
         }
-      );
-    }
+      }
+    );
   } catch (error) {
     console.error("[TranslationSwitch] Error resuming original producer:", error);
   }
@@ -12238,7 +12355,7 @@ const translationSubscribed = async ({
       }));
     }
     if (producerId && startConsumingTranslation) {
-      await startConsumingTranslation(producerId, speakerId, language);
+      await startConsumingTranslation(producerId, speakerId, language, originalProducerId);
     }
     if (showAlert && channelCreated) {
       showAlert({