mediasfu-shared 1.0.3 → 1.0.5

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

@@ -6368,6 +6368,7 @@ const updateRoomParametersClient = ({ parameters }) => {
   }
 };
 const DEFAULT_MEDIA_SFU_ROOM_API_URL = "https://mediasfu.com/v1/rooms/";
+const getDefaultMediaSFURoomApiUrl = () => DEFAULT_MEDIA_SFU_ROOM_API_URL;
 const normalizeManagedRoomApi = (normalizedLink) => {
   if (normalizedLink.includes("/v1/rooms")) {
     return `${normalizedLink.replace(/\/$/, "")}/`;
@@ -6377,7 +6378,7 @@ const normalizeManagedRoomApi = (normalizedLink) => {
 const resolveMediaSFURoomApi = (localLink, action) => {
   const normalizedLink = localLink?.trim();
   if (!normalizedLink) {
-    return DEFAULT_MEDIA_SFU_ROOM_API_URL;
+    return getDefaultMediaSFURoomApiUrl();
   }
   if (normalizedLink.includes("mediasfu.com")) {
     return normalizeManagedRoomApi(normalizedLink);
@@ -7917,6 +7918,9 @@ const sendMessage = async ({
   chatSetting
 }) => {
   let chatValue = false;
+  const normalizedReceivers = (receivers ?? []).filter(
+    (receiver) => typeof receiver === "string" && receiver.trim().length > 0
+  );
   if (messagesLength > 100 && roomName.startsWith("d") || messagesLength > 500 && roomName.startsWith("s") || messagesLength > 1e5 && roomName.startsWith("p")) {
     showAlert?.({
       message: "You have reached the maximum number of messages allowed.",
@@ -7933,7 +7937,7 @@ const sendMessage = async ({
     });
     return;
   }
-  if (receivers.length < 1 && group === false) {
+  if (normalizedReceivers.length < 1 && group === false && islevel === "2") {
     showAlert?.({
       message: "Please select a message to reply to",
       type: "danger",
@@ -7943,7 +7947,7 @@ const sendMessage = async ({
   }
   const messageObject = {
     sender: sender ? sender : member,
-    receivers,
+    receivers: normalizedReceivers,
     message,
     timestamp: (/* @__PURE__ */ new Date()).toLocaleTimeString(),
     group: group !== void 0 && group !== null ? group : false
@@ -10100,13 +10104,112 @@ const TTS_SUPPORT_BY_LANGUAGE = {
   ca: "good",
   auto: "n/a"
 };
+const LANGUAGE_NAMES_EN = {
+  en: "English",
+  es: "Spanish",
+  fr: "French",
+  de: "German",
+  it: "Italian",
+  pt: "Portuguese",
+  nl: "Dutch",
+  ru: "Russian",
+  zh: "Chinese",
+  ja: "Japanese",
+  ko: "Korean",
+  ar: "Arabic",
+  hi: "Hindi",
+  bn: "Bengali",
+  pa: "Punjabi",
+  te: "Telugu",
+  mr: "Marathi",
+  ta: "Tamil",
+  ur: "Urdu",
+  gu: "Gujarati",
+  kn: "Kannada",
+  ml: "Malayalam",
+  ne: "Nepali",
+  si: "Sinhala",
+  tr: "Turkish",
+  pl: "Polish",
+  vi: "Vietnamese",
+  th: "Thai",
+  id: "Indonesian",
+  ms: "Malay",
+  tl: "Filipino",
+  km: "Khmer",
+  lo: "Lao",
+  my: "Burmese",
+  sw: "Swahili",
+  yo: "Yoruba",
+  ha: "Hausa",
+  ig: "Igbo",
+  zu: "Zulu",
+  xh: "Xhosa",
+  af: "Afrikaans",
+  st: "Sesotho",
+  tn: "Tswana",
+  sn: "Shona",
+  am: "Amharic",
+  so: "Somali",
+  rw: "Kinyarwanda",
+  mg: "Malagasy",
+  ny: "Chichewa",
+  ee: "Ewe",
+  tw: "Twi",
+  gaa: "Ga",
+  he: "Hebrew",
+  fa: "Persian",
+  ps: "Pashto",
+  ku: "Kurdish",
+  uk: "Ukrainian",
+  el: "Greek",
+  cs: "Czech",
+  ro: "Romanian",
+  hu: "Hungarian",
+  sv: "Swedish",
+  da: "Danish",
+  no: "Norwegian",
+  fi: "Finnish",
+  sk: "Slovak",
+  bg: "Bulgarian",
+  hr: "Croatian",
+  et: "Estonian",
+  lt: "Lithuanian",
+  lv: "Latvian",
+  sl: "Slovenian",
+  sr: "Serbian",
+  bs: "Bosnian",
+  mk: "Macedonian",
+  is: "Icelandic",
+  ga: "Irish",
+  cy: "Welsh",
+  mt: "Maltese",
+  lb: "Luxembourgish",
+  sq: "Albanian",
+  be: "Belarusian",
+  ka: "Georgian",
+  hy: "Armenian",
+  az: "Azerbaijani",
+  eu: "Basque",
+  gl: "Galician",
+  ca: "Catalan",
+  la: "Latin",
+  eo: "Esperanto",
+  kk: "Kazakh",
+  uz: "Uzbek",
+  tg: "Tajik",
+  ky: "Kyrgyz",
+  tk: "Turkmen",
+  mn: "Mongolian"
+};
 const getDisplayName = (code, locale, fallback) => {
   try {
     const displayNames = new Intl.DisplayNames([locale], { type: "language" });
-    return displayNames.of(code) || fallback;
+    const result = displayNames.of(code);
+    if (result) return result;
   } catch {
-    return fallback;
   }
+  return LANGUAGE_NAMES_EN[code] ?? fallback;
 };
 const normalizeLanguageCode = (code) => {
   if (!code || typeof code !== "string") {
@@ -10153,6 +10256,58 @@ const getSupportedLanguages = (displayLocale = "en") => {
     };
   }).sort((left, right) => left.name.localeCompare(right.name));
 };
+const COMMON_LANGUAGE_CODES = [
+  "en",
+  "es",
+  "fr",
+  "de",
+  "it",
+  "pt",
+  "nl",
+  "ru",
+  "zh",
+  "ja",
+  "ko",
+  "ar",
+  "hi",
+  "bn",
+  "tr",
+  "pl",
+  "vi",
+  "th",
+  "id",
+  "ms",
+  "sw",
+  "yo",
+  "ha",
+  "ig",
+  "zu",
+  "am",
+  "tw",
+  "he",
+  "fa",
+  "uk",
+  "el",
+  "cs",
+  "ro",
+  "hu",
+  "sv",
+  "da",
+  "no",
+  "fi"
+];
+const getCommonLanguages = (displayLocale = "en") => {
+  return COMMON_LANGUAGE_CODES.map((code) => {
+    const metadata = getLanguageMetadata(code);
+    return {
+      code,
+      name: getLanguageName(code, displayLocale),
+      nativeName: metadata.nativeName,
+      region: metadata.region,
+      ttsSupport: metadata.ttsSupport
+    };
+  }).sort((left, right) => left.name.localeCompare(right.name));
+};
 const TTS_PROVIDERS = {
   deepgram: { name: "Deepgram Aura", supportsSSML: false, isDefault: true },
   openai: { name: "OpenAI TTS", supportsSSML: false, multilingual: true },
@@ -12893,6 +13048,7 @@ const launchConfigureWhiteboard = ({
 }) => {
   updateIsConfigureWhiteboardModalVisible(!isConfigureWhiteboardModalVisible);
 };
+exports.COMMON_LANGUAGE_CODES = COMMON_LANGUAGE_CODES;
 exports.MediaStream = MediaStream$1;
 exports.MediaStreamTrack = MediaStreamTrack;
 exports.QnHDCons = QnHDCons;
@@ -12980,6 +13136,7 @@ exports.generateRandomRequestList = generateRandomRequestList;
 exports.generateRandomWaitingRoomList = generateRandomWaitingRoomList;
 exports.getActiveTranslationConsumers = getActiveTranslationConsumers;
 exports.getAvailableVoices = getAvailableVoices;
+exports.getCommonLanguages = getCommonLanguages;
 exports.getDomains = getDomains;
 exports.getEstimate = getEstimate;
 exports.getLanguageMetadata = getLanguageMetadata;