mediasfu-shared 1.0.6 → 1.2.0

package/dist/consumers/translationConsumerSwitch.d.ts

@@ -0,0 +1,67 @@
+import { BreakoutParticipant, EventType, Participant, Transport } from '../types/types';
+export interface TranslationConsumerSwitchParameters {
+    consumerTransports: Transport[];
+    roomName: string;
+    member: string;
+    updateConsumerTransports: (transports: Transport[]) => void;
+    breakOutRoomStarted?: boolean;
+    breakOutRoomEnded?: boolean;
+    breakoutRooms?: BreakoutParticipant[][];
+    limitedBreakRoom?: BreakoutParticipant[];
+    participants?: Participant[];
+    ref_participants?: Participant[];
+    islevel?: string;
+    eventType?: EventType;
+    hostNewRoom?: number;
+    [key: string]: any;
+}
+export interface PauseOriginalProducerOptions {
+    originalProducerId: string;
+    speakerId?: string;
+    parameters: TranslationConsumerSwitchParameters;
+}
+export interface ResumeOriginalProducerOptions {
+    originalProducerId: string;
+    speakerId?: string;
+    parameters: TranslationConsumerSwitchParameters;
+}
+export type PauseOriginalProducerType = (options: PauseOriginalProducerOptions) => Promise<void>;
+export type ResumeOriginalProducerType = (options: ResumeOriginalProducerOptions) => Promise<void>;
+export interface StopConsumingTranslationOptions {
+    speakerId?: string;
+    language: string;
+    translationProducerMap: Record<string, Record<string, string>>;
+    parameters: TranslationConsumerSwitchParameters;
+}
+export type StopConsumingTranslationType = (options: StopConsumingTranslationOptions) => Promise<string | null>;
+export declare const isSpeakerInMyBreakoutRoom: (speakerName: string, parameters: TranslationConsumerSwitchParameters) => boolean;
+export declare const pauseOriginalProducer: ({ originalProducerId, speakerId, parameters, }: PauseOriginalProducerOptions) => Promise<void>;
+export declare const resumeOriginalProducer: ({ originalProducerId, speakerId, parameters, }: ResumeOriginalProducerOptions) => Promise<void>;
+export declare const isConsumingTranslationForSpeaker: (speakerId: string, consumerTransports: Transport[], translationProducerMap: Map<string, {
+    translationProducerId: string;
+    originalProducerId: string;
+    language: string;
+}>) => {
+    consuming: boolean;
+    language?: string;
+    translationProducerId?: string;
+    originalProducerId?: string;
+};
+export declare const getActiveTranslationConsumers: (translationProducerMap: Map<string, {
+    translationProducerId: string;
+    originalProducerId: string;
+    language: string;
+}>, consumerTransports: Transport[]) => Array<{
+    speakerId: string;
+    translationProducerId: string;
+    originalProducerId: string;
+    language: string;
+}>;
+export declare const findOriginalProducerForSpeaker: (speakerId: string, allAudioStreams: Array<{
+    producerId: string;
+    name?: string;
+    [key: string]: any;
+}>) => string | null;
+export declare const stopConsumingTranslation: (options: StopConsumingTranslationOptions) => Promise<string | null>;
+export declare const syncTranslationStateAfterBreakoutChange: (translationProducerMap: Record<string, Record<string, string>>, speakerIdByProducerId: Record<string, string>, parameters: TranslationConsumerSwitchParameters) => Promise<void>;
+//# sourceMappingURL=translationConsumerSwitch.d.ts.map

package/dist/consumers/translationConsumerSwitch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translationConsumerSwitch.d.ts","sourceRoot":"","sources":["../../src/consumers/translationConsumerSwitch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAExF,MAAM,WAAW,mCAAmC;IAClD,kBAAkB,EAAE,SAAS,EAAE,CAAC;IAChC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,wBAAwB,EAAE,CAAC,UAAU,EAAE,SAAS,EAAE,KAAK,IAAI,CAAC;IAC5D,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,aAAa,CAAC,EAAE,mBAAmB,EAAE,EAAE,CAAC;IACxC,gBAAgB,CAAC,EAAE,mBAAmB,EAAE,CAAC;IACzC,YAAY,CAAC,EAAE,WAAW,EAAE,CAAC;IAC7B,gBAAgB,CAAC,EAAE,WAAW,EAAE,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,4BAA4B;IAC3C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,mCAAmC,CAAC;CACjD;AAED,MAAM,WAAW,6BAA6B;IAC5C,kBAAkB,EAAE,MAAM,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,mCAAmC,CAAC;CACjD;AAED,MAAM,MAAM,yBAAyB,GAAG,CAAC,OAAO,EAAE,4BAA4B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AACjG,MAAM,MAAM,0BAA0B,GAAG,CAAC,OAAO,EAAE,6BAA6B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnG,MAAM,WAAW,+BAA+B;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/D,UAAU,EAAE,mCAAmC,CAAC;CACjD;AAED,MAAM,MAAM,4BAA4B,GAAG,CAAC,OAAO,EAAE,+BAA+B,KAAK,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;AAEhH,eAAO,MAAM,yBAAyB,GACpC,aAAa,MAAM,EACnB,YAAY,mCAAmC,KAC9C,OA6CF,CAAC;AAEF,eAAO,MAAM,qBAAqB,GAAU,gDAIzC,4BAA4B,KAAG,OAAO,CAAC,IAAI,CAkC7C,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAU,gDAI1C,6BAA6B,KAAG,OAAO,CAAC,IAAI,CAsC9C,CAAC;AAEF,eAAO,MAAM,gCAAgC,GAC3C,WAAW,MAAM,EACjB,oBAAoB,SAAS,EAAE,EAC/B,wBAAwB,GAAG,CAAC,MAAM,EAAE;IAAE,qBAAqB,EAAE,MAAM,CAAC;IAAC,kBAAkB,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,KACnH;IAAE,SAAS,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAAC,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAmBtG,CAAC;AAEF,eAAO,MAAM,6BAA6B,GACxC,wBAAwB,GAAG,CAAC,MAAM,EAAE;IAAE,qBAAqB,EAAE,MAAM,CAAC;IAAC,kBAAkB,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC,EACpH,oBAAoB,SAAS,EAAE,KAC9B,KAAK,CAAC;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,qBAAqB,EAAE,MAAM,CAAC;IAAC,kBAAkB,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAiB1G,CAAC;AAEF,eAAO,MAAM,8BAA8B,GACzC,WAAW,MAAM,EACjB,iBAAiB,KAAK,CAAC;IAAE,UAAU,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;CAAE,CAAC,KAChF,MAAM,GAAG,IAKX,CAAC;AAEF,eAAO,MAAM,wBAAwB,GAAU,SAAS,+BAA+B,KAAG,OAAO,CAAC,MAAM,GAAG,IAAI,CAkD9G,CAAC;AAEF,eAAO,MAAM,uCAAuC,GAClD,wBAAwB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,EAC9D,uBAAuB,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC7C,YAAY,mCAAmC,KAC9C,OAAO,CAAC,IAAI,CA8Bd,CAAC"}

package/dist/consumers/trigger.d.ts

@@ -0,0 +1,71 @@
+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;
+    autoAdjust: AutoAdjustType;
+    getUpdatedAllParams: () => TriggerParameters;
+    [key: string]: any;
+}
+export interface TriggerOptions {
+    ref_ActiveNames: string[];
+    parameters: TriggerParameters;
+}
+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 declare function trigger({ ref_ActiveNames, parameters, }: TriggerOptions): Promise<void>;
+//# sourceMappingURL=trigger.d.ts.map

package/dist/consumers/trigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../src/consumers/trigger.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAErF,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,YAAY,EAAE,WAAW,EAAE,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAChC,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,SAAS,EAAE,SAAS,CAAC;IACrB,MAAM,EAAE,OAAO,CAAC;IAChB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,iBAAiB,EAAE,OAAO,CAAC;IAC3B,eAAe,EAAE,OAAO,CAAC;IACzB,qBAAqB,EAAE,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IAC1D,gBAAgB,EAAE,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI,KAAK,IAAI,CAAC;IACtD,kBAAkB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,IAAI,CAAC;IAInD,UAAU,EAAE,cAAc,CAAC;IAE3B,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;IAC7C,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,cAAc;IAC7B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,UAAU,EAAE,iBAAiB,CAAC;CAC/B;AAGD,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwCG;AAEH,wBAAsB,OAAO,CAAC,EAC5B,eAAe,EACf,UAAU,GACX,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC,CAsKhC"}

package/dist/consumers/updateMiniCardsGrid.d.ts

@@ -0,0 +1,65 @@
+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 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 declare function updateMiniCardsGrid({ rows, cols, defal, actualRows, parameters, }: UpdateMiniCardsGridOptions): Promise<void>;
+//# sourceMappingURL=updateMiniCardsGrid.d.ts.map

package/dist/consumers/updateMiniCardsGrid.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateMiniCardsGrid.d.ts","sourceRoot":"","sources":["../../src/consumers/updateMiniCardsGrid.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AACtE,MAAM,WAAW,6BAA6B;IAC5C,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,cAAc,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACvC,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1C,iBAAiB,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IAC1C,eAAe,EAAE,CAAC,SAAS,EAAE,SAAS,KAAK,IAAI,CAAC;IAChD,SAAS,EAAE,SAAS,CAAC;IACrB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,qBAAqB,EAAE,MAAM,CAAC;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,cAAc,EAAE,cAAc,CAAC;IAC/B,SAAS,EAAE,SAAS,CAAC;IAErB,mBAAmB,EAAE,MAAM,6BAA6B,CAAC;IACzD,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,6BAA6B,CAAC;CAC3C;AAGD,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,EAAE,0BAA0B,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE7F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AAGH,wBAAsB,mBAAmB,CAAC,EACxC,IAAI,EACJ,IAAI,EACJ,KAAY,EACZ,UAAc,EACd,UAAU,GACX,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC,CAwE5C"}

package/dist/consumers/updateParticipantAudioDecibels.d.ts

@@ -0,0 +1,31 @@
+import { AudioDecibels } from '../types/types';
+export interface UpdateParticipantAudioDecibelsOptions {
+    name: string;
+    averageLoudness: number;
+    audioDecibels: AudioDecibels[];
+    updateAudioDecibels: (audioDecibels: AudioDecibels[]) => void;
+}
+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 declare function updateParticipantAudioDecibels({ name, averageLoudness, audioDecibels, updateAudioDecibels, }: UpdateParticipantAudioDecibelsOptions): void;
+//# sourceMappingURL=updateParticipantAudioDecibels.d.ts.map

package/dist/consumers/updateParticipantAudioDecibels.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateParticipantAudioDecibels.d.ts","sourceRoot":"","sources":["../../src/consumers/updateParticipantAudioDecibels.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,gBAAgB,CAAC;AAC/C,MAAM,WAAW,qCAAqC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;IACxB,aAAa,EAAE,aAAa,EAAE,CAAC;IAC/B,mBAAmB,EAAE,CAAC,aAAa,EAAE,aAAa,EAAE,KAAK,IAAI,CAAC;CAC/D;AAGD,MAAM,MAAM,kCAAkC,GAAG,CAAC,OAAO,EAAE,qCAAqC,KAAK,IAAI,CAAC;AAG1G;;;;;;;;;;;;;;;;;;;;GAoBG;AAEH,wBAAgB,8BAA8B,CAAC,EAC7C,IAAI,EACJ,eAAe,EACf,aAAa,EACb,mBAAmB,GACpB,EAAE,qCAAqC,GAAG,IAAI,CAgB9C"}