mediasfu-shared 1.0.6 → 1.2.0

package/dist/methods/whiteboard/launchConfigureWhiteboard.d.ts

@@ -0,0 +1,23 @@
+export interface LaunchConfigureWhiteboardOptions {
+    updateIsConfigureWhiteboardModalVisible: (visible: boolean) => void;
+    isConfigureWhiteboardModalVisible: boolean;
+}
+export type LaunchConfigureWhiteboardType = (options: LaunchConfigureWhiteboardOptions) => void;
+/**
+ * Toggles the visibility of the configure whiteboard modal.
+ *
+ * @param {LaunchConfigureWhiteboardOptions} options - The options for toggling the whiteboard modal visibility.
+ * @param {Function} options.updateIsConfigureWhiteboardModalVisible - Function to update the visibility state of the configure whiteboard modal.
+ * @param {boolean} options.isConfigureWhiteboardModalVisible - Current visibility state of the configure whiteboard modal.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   updateIsConfigureWhiteboardModalVisible: (visible: boolean) => console.log('Modal visibility updated:', visible),
+ *   isConfigureWhiteboardModalVisible: false,
+ * }
+ * launchConfigureWhiteboard(options)
+ * ```
+ */
+export declare const launchConfigureWhiteboard: LaunchConfigureWhiteboardType;
+//# sourceMappingURL=launchConfigureWhiteboard.d.ts.map

package/dist/methods/whiteboard/launchConfigureWhiteboard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"launchConfigureWhiteboard.d.ts","sourceRoot":"","sources":["../../../src/methods/whiteboard/launchConfigureWhiteboard.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gCAAgC;IAC/C,uCAAuC,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,CAAA;IACnE,iCAAiC,EAAE,OAAO,CAAA;CAC3C;AAED,MAAM,MAAM,6BAA6B,GAAG,CAAC,OAAO,EAAE,gCAAgC,KAAK,IAAI,CAAA;AAE/F;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,yBAAyB,EAAE,6BAKvC,CAAA"}

package/dist/producers/producerEmits/joinConRoom.d.ts

@@ -0,0 +1,54 @@
+import { Socket } from 'socket.io-client';
+import { RtpCapabilities } from 'mediasoup-client/types';
+export interface JoinConRoomOptions {
+    socket: Socket;
+    roomName: string;
+    islevel: string;
+    member: string;
+    sec: string;
+    apiUserName: string;
+}
+export interface JoinConRoomResponse {
+    success: boolean;
+    rtpCapabilities: RtpCapabilities | null;
+    reason?: string;
+    banned?: boolean;
+    suspended?: boolean;
+    noAdmin?: boolean;
+    [key: string]: any;
+}
+export type JoinConRoomType = (options: JoinConRoomOptions) => Promise<JoinConRoomResponse>;
+/**
+ * Joins a conference room using the provided options.
+ *
+ * @param {JoinConRoomOptions} options - The options for joining the conference room.
+ * @param {Socket} options.socket - The socket instance to use for communication.
+ * @param {string} options.roomName - The name of the room to join.
+ * @param {string} options.islevel - The level of the user.
+ * @param {string} options.member - The member identifier.
+ * @param {string} options.sec - The security token.
+ * @param {string} options.apiUserName - The API username.
+ *
+ * @returns {Promise<JoinConRoomResponse>} A promise that resolves with the response of the join operation.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   socket: socketInstance,
+ *   roomName: "s12345678",
+ *   islevel: "1",
+ *   member: "user123",
+ *   sec: "64CharacterLongSecretHere",
+ *   apiUserName: "user123",
+ * };
+ *
+ * try {
+ *   const response = await joinConRoom(options);
+ *   console.log("Room joined:", response);
+ * } catch (error) {
+ *   console.error("Failed to join room:", error);
+ * }
+ * ```
+ */
+export declare function joinConRoom({ socket, roomName, islevel, member, sec, apiUserName }: JoinConRoomOptions): Promise<JoinConRoomResponse>;
+//# sourceMappingURL=joinConRoom.d.ts.map

package/dist/producers/producerEmits/joinConRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinConRoom.d.ts","sourceRoot":"","sources":["../../../src/producers/producerEmits/joinConRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAE1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAE9D,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAID,MAAM,MAAM,eAAe,GAAG,CAAC,OAAO,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAE5F;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+BG;AAEH,wBAAsB,WAAW,CAC/B,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,EAAE,kBAAkB,GAC1E,OAAO,CAAC,mBAAmB,CAAC,CA0F9B"}

package/dist/producers/producerEmits/joinLocalRoom.d.ts

@@ -0,0 +1,30 @@
+import { Socket } from 'socket.io-client';
+import { PreJoinPageParameters, ResponseJoinLocalRoom } from '../../types/shared-base-types';
+import { JoinRoomOnMediaSFUType } from '../../methods/utils/joinRoomOnMediaSFU';
+export interface JoinLocalRoomOptions {
+    socket: Socket;
+    roomName: string;
+    islevel: string;
+    member: string;
+    sec: string;
+    apiUserName: string;
+    parameters: PreJoinPageParameters;
+    checkConnect?: boolean;
+    joinMediaSFURoom?: JoinRoomOnMediaSFUType;
+    localLink?: string;
+}
+export type JoinLocalRoomType = (options: JoinLocalRoomOptions) => Promise<ResponseJoinLocalRoom>;
+export interface CheckMediasfuURLOptions {
+    data: ResponseJoinLocalRoom;
+    member: string;
+    roomName: string;
+    islevel: string;
+    socket: Socket;
+    parameters: PreJoinPageParameters;
+    joinMediaSFURoom?: JoinRoomOnMediaSFUType;
+    localLink?: string;
+}
+export type CheckMediasfuURLType = (options: CheckMediasfuURLOptions) => Promise<void>;
+export declare function checkMediasfuURL({ data, member, roomName, islevel, socket, parameters, joinMediaSFURoom, localLink, }: CheckMediasfuURLOptions): Promise<void>;
+export declare function joinLocalRoom({ socket, roomName, islevel, member, sec, apiUserName, parameters, checkConnect, joinMediaSFURoom, localLink, }: JoinLocalRoomOptions): Promise<ResponseJoinLocalRoom>;
+//# sourceMappingURL=joinLocalRoom.d.ts.map

package/dist/producers/producerEmits/joinLocalRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinLocalRoom.d.ts","sourceRoot":"","sources":["../../../src/producers/producerEmits/joinLocalRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,EAEL,qBAAqB,EACrB,qBAAqB,EACtB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAsB,sBAAsB,EAAE,MAAM,wCAAwC,CAAC;AAGpG,MAAM,WAAW,oBAAoB;IACnC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,qBAAqB,CAAC;IAClC,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,CAC9B,OAAO,EAAE,oBAAoB,KAC1B,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAEpC,MAAM,WAAW,uBAAuB;IACtC,IAAI,EAAE,qBAAqB,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,qBAAqB,CAAC;IAClC,gBAAgB,CAAC,EAAE,sBAAsB,CAAC;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,uBAAuB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvF,wBAAsB,gBAAgB,CAAC,EACrC,IAAI,EACJ,MAAM,EACN,QAAQ,EACR,OAAO,EACP,MAAM,EACN,UAAU,EACV,gBAAqC,EACrC,SAAc,GACf,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC,CAgFzC;AAED,wBAAsB,aAAa,CAAC,EAClC,MAAM,EACN,QAAQ,EACR,OAAO,EACP,MAAM,EACN,GAAG,EACH,WAAW,EACX,UAAU,EACV,YAAoB,EACpB,gBAAqC,EACrC,SAAc,GACf,EAAE,oBAAoB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAiGvD"}

package/dist/producers/producerEmits/joinRoom.d.ts

@@ -0,0 +1,35 @@
+import { Socket } from 'socket.io-client';
+import { RtpCapabilities } from 'mediasoup-client/types';
+export interface JoinRoomOptions {
+    socket: Socket;
+    roomName: string;
+    islevel: string;
+    member: string;
+    sec: string;
+    apiUserName: string;
+}
+export interface JoinRoomResponse {
+    success: boolean;
+    rtpCapabilities: RtpCapabilities | null;
+    reason?: string;
+    banned?: boolean;
+    suspended?: boolean;
+    noAdmin?: boolean;
+    [key: string]: any;
+}
+export type JoinRoomType = (options: JoinRoomOptions) => Promise<JoinRoomResponse>;
+/**
+ * Joins a user to a specified room via a socket connection.
+ *
+ * @param {JoinRoomOptions} options - The options for joining the room.
+ * @param {Socket} options.socket - The socket instance to use for communication.
+ * @param {string} options.roomName - The name of the room to join.
+ * @param {string} options.islevel - The level of the user.
+ * @param {string} options.member - The member identifier.
+ * @param {string} options.sec - The security token.
+ * @param {string} options.apiUserName - The API username of the user.
+ *
+ * @returns {Promise<JoinRoomResponse>} A promise that resolves with the data received from the 'joinRoom' event or rejects with a validation error.
+ */
+export declare function joinRoom({ socket, roomName, islevel, member, sec, apiUserName, }: JoinRoomOptions): Promise<JoinRoomResponse>;
+//# sourceMappingURL=joinRoom.d.ts.map

package/dist/producers/producerEmits/joinRoom.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"joinRoom.d.ts","sourceRoot":"","sources":["../../../src/producers/producerEmits/joinRoom.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC1C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAG9D,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACpB;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,OAAO,EAAE,eAAe,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC;AAEnF;;;;;;;;;;;;GAYG;AACH,wBAAsB,QAAQ,CAAC,EAC7B,MAAM,EACN,QAAQ,EACR,OAAO,EACP,MAAM,EACN,GAAG,EACH,WAAW,GACZ,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAmF7C"}

package/dist/sockets/SocketManager.d.ts

@@ -0,0 +1,102 @@
+import { MeetingRoomParams, RecordingParams } from '../types/types';
+import { Socket } from 'socket.io-client';
+export interface ResponseLocalConnection {
+    socket?: Socket;
+    data?: ResponseLocalConnectionData;
+}
+export interface ResponseLocalConnectionData {
+    socketId: string;
+    mode: string;
+    apiUserName?: string;
+    apiKey?: string;
+    allowRecord: boolean;
+    meetingRoomParams_: MeetingRoomParams;
+    recordingParams_: RecordingParams;
+}
+export interface ConnectLocalSocketOptions {
+    link: string;
+}
+export interface ConnectSocketOptions {
+    apiUserName: string;
+    apiKey?: string;
+    apiToken?: string;
+    link: string;
+}
+export interface DisconnectSocketOptions {
+    socket: Socket;
+}
+export type ConnectSocketType = (options: ConnectSocketOptions) => Promise<Socket>;
+export type DisconnectSocketType = (options: DisconnectSocketOptions) => Promise<boolean>;
+export type ConnectLocalSocketType = (options: ConnectLocalSocketOptions) => Promise<ResponseLocalConnection>;
+/**
+ * Connects to a media socket using the provided connection options.
+ *
+ * @param {ConnectSocketOptions} options - The connection options.
+ * @param {string} options.apiUserName - The API username.
+ * @param {string} [options.apiKey] - The API key (optional if apiToken is provided).
+ * @param {string} [options.apiToken] - The API token (optional if apiKey is provided).
+ * @param {string} options.link - The socket link.
+ *
+ * @returns {Promise<Socket>} A promise that resolves to the connected socket.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   apiUserName: 'user123',
+ *   apiKey: 'yourApiKeyHere',
+ *   link: 'https://socketlink.com',
+ * };
+ *
+ * try {
+ *   const socket = await connectSocket(options);
+ *   console.log('Connected to socket:', socket);
+ * } catch (error) {
+ *   console.error('Failed to connect to socket:', error);
+ * }
+ * ```
+ */
+declare function connectSocket({ apiUserName, apiKey, apiToken, link }: ConnectSocketOptions): Promise<Socket>;
+/**
+ * Connects to a local media socket using the provided connection options.
+ *
+ * @param {ConnectLocalSocketOptions} options - The connection options.
+ * @param {string} options.link - The socket link.
+ *
+ * @returns {Promise<ResponseLocalConnection>} A promise that resolves to the connected socket and data.
+ *
+ * @example
+ * ```typescript
+ * const options = {
+ *   link: 'http://localhost:3000',
+ * };
+ *
+ * try {
+ *   const { socket, data } = await connectLocalSocket(options);
+ *   console.log('Connected to socket:', socket, data);
+ * } catch (error) {
+ *   console.error('Failed to connect to socket:', error);
+ * }
+ * ```
+ */
+declare function connectLocalSocket({ link }: ConnectLocalSocketOptions): Promise<ResponseLocalConnection>;
+/**
+ * Disconnects from the socket.
+ *
+ * @param {Socket} socket - The socket instance to disconnect.
+ * @returns {Promise<boolean>} - A promise that resolves once the socket is disconnected.
+ *
+ * @example
+ * ```typescript
+ * const options = { socket: socketInstance };
+ *
+ * try {
+ *   const isDisconnected = await disconnectSocket(options);
+ *   console.log('Disconnected:', isDisconnected);
+ * } catch (error) {
+ *   console.error('Failed to disconnect:', error);
+ * }
+ * ```
+ */
+declare function disconnectSocket({ socket }: DisconnectSocketOptions): Promise<boolean>;
+export { connectSocket, disconnectSocket, connectLocalSocket };
+//# sourceMappingURL=SocketManager.d.ts.map

package/dist/sockets/SocketManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocketManager.d.ts","sourceRoot":"","sources":["../../src/sockets/SocketManager.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AACpE,OAAW,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAe9C,MAAM,WAAW,uBAAuB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,2BAA2B,CAAC;CACpC;AAED,MAAM,WAAW,2BAA2B;IAC1C,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,OAAO,CAAC;IACrB,kBAAkB,EAAE,iBAAiB,CAAC;IACtC,gBAAgB,EAAE,eAAe,CAAC;CACnC;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAoB;IACnC,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,uBAAuB;IACtC,MAAM,EAAE,MAAM,CAAC;CAChB;AAGD,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,EAAE,oBAAoB,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;AACnF,MAAM,MAAM,oBAAoB,GAAG,CAAC,OAAO,EAAE,uBAAuB,KAAK,OAAO,CAAC,OAAO,CAAC,CAAC;AAC1F,MAAM,MAAM,sBAAsB,GAAG,CAAC,OAAO,EAAE,yBAAyB,KAAK,OAAO,CAAC,uBAAuB,CAAC,CAAC;AAG9G;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,iBAAe,aAAa,CAC1B,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,oBAAoB,GAC5D,OAAO,CAAC,MAAM,CAAC,CAsEjB;AAGD;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,iBAAe,kBAAkB,CAAC,EAAE,IAAI,EAAE,EAAE,yBAAyB,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAuBvG;AAED;;;;;;;;;;;;;;;;;GAiBG;AAEH,iBAAe,gBAAgB,CAAC,EAAE,MAAM,EAAE,EAAE,uBAAuB,GAAG,OAAO,CAAC,OAAO,CAAC,CAKrF;AAED,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,CAAC"}