mediasfu-shared 1.0.0

package/src/consumers/trigger.ts

@@ -0,0 +1,250 @@
+import { Socket } from "socket.io-client";
+import { Participant, AutoAdjustType, ScreenState, EventType } from "../types/types";
+
+export interface TriggerParameters {
+  socket: Socket;
+  localSocket?: Socket;
+  roomName: string;
+  screenStates: ScreenState[];
+  participants: Participant[];
+  updateDateState?: number | null;
+  lastUpdate: number | null;
+  nForReadjust: number | null;
+  eventType: EventType;
+  shared: boolean;
+  shareScreenStarted: boolean;
+  whiteboardStarted: boolean;
+  whiteboardEnded: boolean;
+  updateUpdateDateState: (timestamp: number | null) => void;
+  updateLastUpdate: (lastUpdate: number | null) => void;
+  updateNForReadjust: (nForReadjust: number) => void;
+
+
+  // mediasfu functions
+  autoAdjust: AutoAdjustType;
+
+  getUpdatedAllParams: () => TriggerParameters;
+  [key: string]: any;
+}
+
+export interface TriggerOptions {
+  ref_ActiveNames: string[];
+  parameters: TriggerParameters;
+}
+
+// Export the type definition for the function
+export type TriggerType = (options: TriggerOptions) => Promise<void>;
+
+/**
+ * Triggers an update to the screen client based on the provided parameters.
+ *
+ * @param {TriggerOptions} options - The options for triggering the update.
+ * @param {string[]} options.ref_ActiveNames - Reference to the active names.
+ * @param {TriggerParameters} options.parameters - The parameters for the trigger.
+ * 
+ * @returns {Promise<void>} A promise that resolves when the trigger is complete.
+ *
+ * @throws Will throw an error if the updateScreenClient operation fails.
+ *
+ * @remarks
+ * This function handles various conditions to determine the main screen person,
+ * adjusts the screen states, and emits an update to the screen client via socket.
+ *
+ * @example
+ * ```typescript
+ * await trigger({
+ *   ref_ActiveNames: ["user1", "user2"],
+ *   parameters: {
+ *     socket: socketInstance,
+ *     localSocket: localSocketInstance,
+ *     roomName: "room1",
+ *     screenStates: [{ mainScreenPerson: "user1", mainScreenFilled: true, adminOnMainScreen: false }],
+ *     participants: [{ name: "admin", islevel: "2" }],
+ *     updateDateState: 0,
+ *     lastUpdate: null,
+ *     nForReadjust: 0,
+ *     eventType: "conference",
+ *     shared: false,
+ *     shareScreenStarted: false,
+ *     whiteboardStarted: false,
+ *     whiteboardEnded: false,
+ *     updateUpdateDateState: (date) => {},
+ *     updateLastUpdate: (date) => {},
+ *     updateNForReadjust: (n) => {},
+ *     autoAdjust: async ({ n, parameters }) => [n, 0],
+ *   },
+ * });
+ * ```
+ */
+
+export async function trigger({
+  ref_ActiveNames,
+  parameters,
+}: TriggerOptions): Promise<void> {
+  try {
+    parameters = parameters.getUpdatedAllParams();
+
+    let {
+      socket,
+      localSocket,
+      roomName,
+      screenStates,
+      participants,
+      updateDateState,
+      lastUpdate,
+      nForReadjust,
+      eventType,
+      shared,
+      shareScreenStarted,
+      whiteboardStarted,
+      whiteboardEnded,
+      updateUpdateDateState,
+      updateLastUpdate,
+      updateNForReadjust,
+
+      //mediasfu functions
+      autoAdjust,
+    } = parameters;
+
+    let socketRef = socket;
+    if (localSocket && localSocket.id) {
+      socketRef = localSocket;
+    }
+
+    let personOnMainScreen = screenStates[0].mainScreenPerson;
+    let adminName = "";
+    const admin = participants.filter(
+      (participant) => participant.islevel == "2"
+    );
+    if (admin.length > 0) {
+      adminName = admin[0].name || "";
+    }
+
+    if (personOnMainScreen === "WhiteboardActive") {
+      personOnMainScreen = adminName;
+    }
+
+    let mainfilled = screenStates[0].mainScreenFilled;
+    let adminOnMain = screenStates[0].adminOnMainScreen;
+    let nForReadjust_: number;
+    let val1: number;
+
+    let noww = new Date().getTime();
+    //get now in seconds
+    let timestamp = Math.floor(noww / 1000);
+
+    let eventPass = false;
+
+    if (eventType == "conference" && !(shared || shareScreenStarted)) {
+      eventPass = true;
+      personOnMainScreen = adminName;
+
+      if (!ref_ActiveNames.includes(adminName)) {
+        ref_ActiveNames.unshift(adminName);
+      }
+    }
+
+    if ((mainfilled && personOnMainScreen != null && adminOnMain) || eventPass) {
+      if (eventType == "conference") {
+        nForReadjust = nForReadjust! + 1;
+        updateNForReadjust(nForReadjust);
+      }
+
+      if (!ref_ActiveNames.includes(adminName) && whiteboardStarted && !whiteboardEnded) {
+        ref_ActiveNames.unshift(adminName);
+      }
+
+      nForReadjust_ = ref_ActiveNames.length;
+
+      if (nForReadjust_ == 0 && eventType == "webinar") {
+        val1 = 0;
+      } else {
+        const [val11, ] = await autoAdjust({
+          n: nForReadjust_,
+          eventType,
+          shared,
+          shareScreenStarted,
+        });
+        val1 = val11;
+      }
+
+      let calc1 = Math.floor((val1 / 12) * 100);
+      let calc2 = (100) - calc1;
+
+      //check if lastUpdate is not null and at least same seconds
+      if (lastUpdate == null || updateDateState != timestamp) {
+        let now = new Date();
+
+        socketRef.emit(
+          "updateScreenClient",
+          {
+            roomName,
+            names: ref_ActiveNames,
+            mainPercent: calc2,
+            mainScreenPerson: personOnMainScreen,
+            viewType: eventType,
+          },
+          ({ success, reason }: { success: boolean; reason: string; }) => {
+            updateDateState = timestamp;
+            updateUpdateDateState(updateDateState);
+            lastUpdate = Math.floor(now.getTime() / 1000);
+            updateLastUpdate(lastUpdate);
+            if (!success) {
+              console.log(reason, "updateScreenClient failed");
+            }
+          }
+        );
+      }
+    } else if (mainfilled && personOnMainScreen != null && !adminOnMain) {
+      //check if the person on main screen is still in the room
+      // ss = true
+
+      nForReadjust_ = ref_ActiveNames.length;
+
+      if (!ref_ActiveNames.includes(adminName)) {
+        ref_ActiveNames.unshift(adminName);
+      }
+
+      const [val11, ] = await autoAdjust({
+        n: nForReadjust_,
+        eventType,
+        shared,
+        shareScreenStarted,
+      });
+      val1 = val11;
+
+      const calc1 = Math.floor((val1 / 12) * 100);
+      const calc2 = 100 - calc1;
+
+      if (lastUpdate == null || updateDateState !== timestamp) {
+        let now = new Date();
+
+        socketRef.emit(
+          "updateScreenClient",
+          {
+            roomName,
+            names: ref_ActiveNames,
+            mainPercent: calc2,
+            mainScreenPerson: personOnMainScreen,
+            viewType: eventType,
+          },
+          ({ success, reason }: { success: boolean; reason: string; }) => {
+            updateDateState = timestamp;
+            updateUpdateDateState(updateDateState);
+            lastUpdate = Math.floor(now.getTime() / 1000);
+            updateLastUpdate(lastUpdate);
+            if (!success) {
+              console.log(reason, "updateScreenClient failed");
+            }
+          }
+        );
+      }
+    } else {
+      //stop recording
+      console.log("trigger stopRecording");
+    }
+  } catch (error) {
+    console.log("Error triggering updateScreen:", error);
+  }
+}
+

package/src/consumers/updateMiniCardsGrid.ts

@@ -0,0 +1,150 @@
+import { GridSizes, ComponentSizes, EventType } from "../types/types";
+export interface UpdateMiniCardsGridParameters {
+  updateGridRows: (rows: number) => void;
+  updateGridCols: (cols: number) => void;
+  updateAltGridRows: (rows: number) => void;
+  updateAltGridCols: (cols: number) => void;
+  updateGridSizes: (gridSizes: GridSizes) => void;
+  gridSizes: GridSizes;
+  paginationDirection: string;
+  paginationHeightWidth: number;
+  doPaginate: boolean;
+  componentSizes: ComponentSizes;
+  eventType: EventType;
+
+  getUpdatedAllParams: () => UpdateMiniCardsGridParameters;
+  [key: string]: any;
+}
+
+export interface UpdateMiniCardsGridOptions {
+  rows: number;
+  cols: number;
+  defal?: boolean;
+  actualRows?: number;
+  parameters: UpdateMiniCardsGridParameters;
+}
+
+// Export the type definition for the function
+export type UpdateMiniCardsGridType = (options: UpdateMiniCardsGridOptions) => Promise<void>;
+
+/**
+ * Updates the mini cards grid based on the specified rows and columns.
+ *
+ * @param {UpdateMiniCardsGridOptions} options - The function parameters.
+ * @param {number} options.rows - The number of rows in the grid.
+ * @param {number} options.cols - The number of columns in the grid.
+ * @param {boolean} [options.defal] - Flag indicating whether to update the default grid or an alternative grid.
+ * @param {number} [options.actualRows] - The actual number of rows in the grid.
+ * @param {UpdateMiniCardsGridParameters} options.parameters - Additional parameters needed for the function.
+ * @returns {Promise<void>} A promise that resolves when the mini cards grid is updated.
+ *
+ * @throws Will throw an error if the update operation fails.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   rows: 2,
+ *   cols: 3,
+ *   defal: true,
+ *   actualRows: 2,
+ *   parameters: {
+ *     updateGridRows: updateGridRowsFunction,
+ *     updateGridCols: updateGridColsFunction,
+ *     updateAltGridRows: updateAltGridRowsFunction,
+ *     updateAltGridCols: updateAltGridColsFunction,
+ *     updateGridSizes: updateGridSizesFunction,
+ *     gridSizes: { gridWidth: 100, gridHeight: 100 },
+ *     paginationDirection: 'horizontal',
+ *     paginationHeightWidth: 50,
+ *     doPaginate: true,
+ *     componentSizes: { otherWidth: 300, otherHeight: 200 },
+ *     eventType: 'chat',
+ *     getUpdatedAllParams: getUpdatedAllParamsFunction,
+ *   },
+ * };
+ * 
+ * await updateMiniCardsGrid(options);
+ * ```
+ */
+
+
+export async function updateMiniCardsGrid({
+  rows,
+  cols,
+  defal = true,
+  actualRows = 2,
+  parameters,
+}: UpdateMiniCardsGridOptions): Promise<void> {
+  let { getUpdatedAllParams } = parameters;
+
+  parameters = getUpdatedAllParams();
+
+  let {
+    updateGridRows,
+    updateGridCols,
+    updateAltGridRows,
+    updateAltGridCols,
+    updateGridSizes,
+
+    gridSizes,
+    paginationDirection,
+    paginationHeightWidth,
+    doPaginate,
+    componentSizes,
+    eventType,
+  } = parameters;
+
+  let containerWidth = componentSizes.otherWidth;
+  let containerHeight = componentSizes.otherHeight;
+
+  if (doPaginate) {
+    // Adjust container size based on pagination
+    if (paginationDirection === "horizontal") {
+      containerHeight -= paginationHeightWidth;
+    } else {
+      containerWidth -= paginationHeightWidth;
+    }
+  }
+
+  let cardSpacing = 3; // 3px margin between cards
+  if (eventType === "chat") {
+    cardSpacing = 0;
+  }
+
+  let totalSpacingHorizontal = (cols - 1) * cardSpacing;
+  let totalSpacingVertical = (actualRows - 1) * cardSpacing;
+
+  let cardWidth: number;
+  let cardHeight: number;
+
+  if (cols === 0 || actualRows === 0) {
+    cardWidth = 0;
+    cardHeight = 0;
+  } else {
+    cardWidth = Math.floor(
+      (containerWidth - totalSpacingHorizontal) / cols
+    );
+    cardHeight = Math.floor(
+      (containerHeight - totalSpacingVertical) / actualRows
+    );
+  }
+
+  if (defal) {
+    updateGridRows(rows);
+    updateGridCols(cols);
+
+    gridSizes = { ...gridSizes, gridWidth: cardWidth, gridHeight: cardHeight };
+    updateGridSizes(gridSizes);
+  } else {
+    updateAltGridRows(rows);
+    updateAltGridCols(cols);
+
+    gridSizes = {
+      ...gridSizes,
+      altGridWidth: cardWidth,
+      altGridHeight: cardHeight,
+    };
+    updateGridSizes(gridSizes);
+  }
+}
+

package/src/consumers/updateParticipantAudioDecibels.ts

@@ -0,0 +1,56 @@
+import { AudioDecibels } from "../types/types";
+export interface UpdateParticipantAudioDecibelsOptions {
+  name: string;
+  averageLoudness: number;
+  audioDecibels: AudioDecibels[];
+  updateAudioDecibels: (audioDecibels: AudioDecibels[]) => void;
+}
+
+// Export the type definition for the function
+export type UpdateParticipantAudioDecibelsType = (options: UpdateParticipantAudioDecibelsOptions) => void;
+
+
+/**
+ * Updates the audio decibels for a participant.
+ *
+ * @param {UpdateParticipantAudioDecibelsOptions} options - The options for updating participant audio decibels.
+ * @param {string} options.name - The name of the participant.
+ * @param {number} options.averageLoudness - The average loudness of the participant.
+ * @param {Array<AudioDecibels>} options.audioDecibels - The array of audio decibels entries.
+ * @param {Function} options.updateAudioDecibels - The function to update the audio decibels array.
+ *
+ * @returns {void}
+ * 
+ * @example
+ * const options = {
+ *   name: 'participant1',
+ *   averageLoudness: 50,
+ *   audioDecibels: [{ name: 'participant1', averageLoudness: 50 }],
+ *   updateAudioDecibels: updateAudioDecibelsFunction,
+ * };
+ * 
+ * updateParticipantAudioDecibels(options);
+ */
+
+export function updateParticipantAudioDecibels({
+  name,
+  averageLoudness,
+  audioDecibels,  
+  updateAudioDecibels,
+}: UpdateParticipantAudioDecibelsOptions): void {
+
+  // Function to update the audioDecibels array
+  // Check if the entry already exists in audioDecibels
+  const existingEntry = audioDecibels.find((entry) => entry.name === name);
+
+  if (existingEntry) {
+    // Entry exists, update the averageLoudness
+    existingEntry.averageLoudness = averageLoudness;
+  } else {
+    // Entry doesn't exist, add a new entry to audioDecibels
+    audioDecibels.push({ name, averageLoudness });
+  }
+
+  // Update the audioDecibels array
+  updateAudioDecibels(audioDecibels);
+}

package/src/index.ts

@@ -0,0 +1,119 @@
+// Re-export all types
+export * from './types/types';
+
+// Export all consumers
+export * from './consumers/autoAdjust';
+export * from './consumers/calculateRowsAndColumns';
+export * from './consumers/changeVids';
+export * from './consumers/checkGrid';
+export * from './consumers/checkPermission';
+export * from './consumers/checkScreenShare';
+export * from './consumers/closeAndResize';
+export * from './consumers/compareActiveNames';
+export * from './consumers/compareScreenStates';
+export * from './consumers/connectIps';
+export * from './consumers/connectLocalIps';
+export * from './consumers/connectRecvTransport';
+export * from './consumers/connectSendTransport';
+export * from './consumers/connectSendTransportAudio';
+export * from './consumers/connectSendTransportScreen';
+export * from './consumers/connectSendTransportVideo';
+export * from './consumers/controlMedia';
+export * from './consumers/createSendTransport';
+export * from './consumers/disconnectSendTransportAudio';
+export * from './consumers/disconnectSendTransportScreen';
+export * from './consumers/disconnectSendTransportVideo';
+export * from './consumers/dispStreams';
+export * from './consumers/generatePageContent';
+export * from './consumers/getEstimate';
+export * from './consumers/getPipedProducersAlt';
+export * from './consumers/getProducersPiped';
+export * from './consumers/getVideos';
+export * from './consumers/mixStreams';
+export * from './consumers/onScreenChanges';
+export * from './consumers/processConsumerTransports';
+export * from './consumers/processConsumerTransportsAudio';
+export * from './consumers/readjust';
+export * from './consumers/receiveAllPipedTransports';
+export * from './consumers/receiveRoomMessages';
+export * from './consumers/reorderStreams';
+export * from './consumers/rePort';
+export * from './consumers/requestScreenShare';
+export * from './consumers/resumePauseAudioStreams';
+export * from './consumers/resumePauseStreams';
+export * from './consumers/resumeSendTransportAudio';
+export * from './consumers/reUpdateInter';
+export * from './consumers/signalNewConsumerTransport';
+export * from './consumers/socketReceiveMethods/joinConsumeRoom';
+export * from './consumers/socketReceiveMethods/newPipeProducer';
+export * from './consumers/socketReceiveMethods/producerClosed';
+export * from './consumers/startShareScreen';
+export * from './consumers/stopShareScreen';
+export * from './consumers/streamSuccessAudio';
+export * from './consumers/streamSuccessAudioSwitch';
+export * from './consumers/streamSuccessScreen';
+export * from './consumers/streamSuccessVideo';
+export * from './consumers/switchUserAudio';
+export * from './consumers/switchUserVideo';
+export * from './consumers/switchUserVideoAlt';
+export * from './consumers/trigger';
+export * from './consumers/updateMiniCardsGrid';
+export * from './consumers/updateParticipantAudioDecibels';
+// Export all methods
+export * from './methods/background/launchBackground';
+export * from './methods/breakoutRooms/breakoutRoomUpdated';
+export * from './methods/breakoutRooms/handleStartBreakout';
+export * from './methods/breakoutRooms/handleStopBreakout';
+export * from './methods/breakoutRooms/launchBreakoutRooms';
+export * from './methods/coHost/launchCoHost';
+export * from './methods/coHostMethods/modifyCoHostSettings';
+export * from './methods/displaySettings/launchDisplaySettings';
+export * from './methods/displaySettings/modifyDisplaySettings';
+export * from './methods/exit/confirmExit';
+export * from './methods/exit/launchConfirmExit';
+export * from './methods/mediaSettings/launchMediaSettings';
+export * from './methods/menu/launchMenuModal';
+export * from './methods/message/launchMessages';
+export * from './methods/message/sendMessage';
+export * from './methods/participants/launchParticipants';
+export * from './methods/participants/messageParticipants';
+export * from './methods/participants/muteParticipants';
+export * from './methods/participants/removeParticipants';
+export * from './methods/polls/handleCreatePoll';
+export * from './methods/polls/handleEndPoll';
+export * from './methods/polls/handleVotePoll';
+export * from './methods/polls/launchPoll';
+export * from './methods/prejoin/handleCreateRoom';
+export * from './methods/prejoin/handleJoinRoom';
+export * from './methods/recording/checkPauseState';
+export * from './methods/recording/checkResumeState';
+export * from './methods/recording/confirmRecording';
+export * from './methods/recording/launchRecording';
+export * from './methods/recording/recordPauseTimer';
+export * from './methods/recording/recordResumeTimer';
+export * from './methods/recording/recordStartTimer';
+export * from './methods/recording/recordUpdateTimer';
+export * from './methods/recording/startRecording';
+export * from './methods/recording/stopRecording';
+export * from './methods/recording/updateRecording';
+export * from './methods/requests/launchRequests';
+export * from './methods/requests/respondToRequests';
+export * from './methods/settings/launchSettings';
+export * from './methods/settings/modifySettings';
+export * from './methods/stream/switchAudio';
+export * from './methods/stream/switchVideo';
+export * from './methods/stream/switchVideoAlt';
+export * from './methods/waiting/launchWaiting';
+export * from './methods/waiting/respondToWaiting';
+export * from './methods/welcome/handleWelcomeRequest';
+export * from './methods/whiteboard/handleStartWhiteboard';
+export * from './methods/whiteboard/handleStopWhiteboard';
+export * from './methods/whiteboard/launchConfigureWhiteboard';
+// ProducerClient exports
+export * from './ProducerClient/producerClientEmits/createDeviceClient';
+// Producers exports
+export * from './producers/producerEmits/joinConRoom';
+// Socket exports
+export * from './sockets/SocketManager';
+// Stream method exports (clickVideo)
+export * from './methods/stream/clickVideo';

package/src/methods/background/launchBackground.ts

@@ -0,0 +1,16 @@
+export interface LaunchBackgroundOptions {
+  updateIsBackgroundModalVisible: (isVisible: boolean) => void
+  isBackgroundModalVisible: boolean
+}
+
+export type LaunchBackgroundType = (options: LaunchBackgroundOptions) => void
+
+/**
+ * Toggles the visibility of the background modal.
+ */
+export const launchBackground: LaunchBackgroundType = ({
+  updateIsBackgroundModalVisible,
+  isBackgroundModalVisible,
+}: LaunchBackgroundOptions): void => {
+  updateIsBackgroundModalVisible(!isBackgroundModalVisible)
+}