plugnmeet-sdk-js 1.2.0 → 1.2.2

package/src/types/activeRoomsInfo.ts

@@ -0,0 +1,7 @@
+import { Room } from './activeRoomInfo';
+
+export type ActiveRoomsInfoResponse = {
+  status: boolean;
+  msg: string;
+  rooms?: Array<Room>;
+};

package/src/types/clientFiles.ts

@@ -0,0 +1,6 @@
+export type ClientFilesResponse = {
+    status: boolean;
+    msg: string;
+    css?: Array<string>;
+    js?: Array<string>;
+};

package/src/types/createRoom.ts

@@ -0,0 +1,95 @@
+export type CreateRoomParams = {
+  room_id: string;
+  max_participants?: number;
+  empty_timeout?: number;
+  metadata: RooMetadata;
+};
+
+export type RooMetadata = {
+  room_title: string;
+  welcome_message?: string;
+  webhook_url?: string;
+  logout_url?: string;
+  room_features: RoomFeaturesParams;
+  default_lock_settings?: LockSettingsParams;
+};
+
+export type RoomFeaturesParams = {
+  allow_webcams: boolean;
+  mute_on_start: boolean;
+  allow_screen_share: boolean;
+  allow_rtmp: boolean;
+  admin_only_webcams: boolean;
+  allow_view_other_webcams: boolean;
+  allow_view_other_users_list: boolean;
+  recording_features: RecordingFeaturesParams;
+  chat_features: ChatFeaturesParams;
+  shared_note_pad_features?: SharedNotePadFeaturesParams;
+  whiteboard_features?: WhiteboardFeaturesParams;
+  external_media_player_features?: ExternalMediaPlayerFeatures;
+  waiting_room_features?: WaitingRoomFeatures;
+  breakout_room_features?: BreakoutRoomFeatures;
+};
+
+export type RecordingFeaturesParams = {
+  is_allow: boolean;
+  is_allow_cloud: boolean;
+  is_allow_local: boolean;
+  enable_auto_cloud_recording: boolean;
+};
+
+export type ChatFeaturesParams = {
+  allow_chat: boolean;
+  allow_file_upload: boolean;
+  allowed_file_types: Array<string>;
+  max_file_size: number;
+};
+
+export type SharedNotePadFeaturesParams = {
+  allowed_shared_note_pad: boolean;
+};
+
+export type WhiteboardFeaturesParams = {
+  allowed_whiteboard: boolean;
+};
+
+export type ExternalMediaPlayerFeatures = {
+  allowed_external_media_player: boolean;
+};
+
+export type WaitingRoomFeatures = {
+  is_active: boolean;
+  waiting_room_msg?: string;
+};
+
+export type BreakoutRoomFeatures = {
+  is_allow: boolean;
+};
+
+export type LockSettingsParams = {
+  lock_microphone?: boolean;
+  lock_webcam?: boolean;
+  lock_screen_sharing?: boolean;
+  lock_whiteboard?: boolean;
+  lock_shared_notepad?: boolean;
+  lock_chat?: boolean;
+  lock_chat_send_message?: boolean;
+  lock_chat_file_share?: boolean;
+};
+
+export type CreateRoomResponse = {
+  status: boolean;
+  msg: string;
+  roomInfo?: CreateRoomResponseRoomInfo;
+};
+
+export type CreateRoomResponseRoomInfo = {
+  sid: string;
+  name: string;
+  max_participants: number;
+  empty_timeout: number;
+  creation_time: number;
+  turn_password: string;
+  enabled_codecs: Array<any>;
+  metadata: string;
+};

package/src/types/deleteRecordings.ts

@@ -0,0 +1,8 @@
+export type DeleteRecordingsParams = {
+  record_id: string;
+};
+
+export type DeleteRecordingsResponse = {
+  status: boolean;
+  msg: string;
+};

package/src/types/endRoom.ts

@@ -0,0 +1,8 @@
+export type EndRoomParams = {
+  room_id: string;
+};
+
+export type EndRoomResponse = {
+  status: boolean;
+  msg: string;
+};

package/src/types/fetchRecordings.ts

@@ -0,0 +1,30 @@
+export type FetchRecordingsParams = {
+  room_ids: Array<string>;
+  from?: number;
+  limit?: number;
+  order_by?: 'ASC' | 'DESC';
+};
+
+export type FetchRecordingsResponse = {
+  status: boolean;
+  msg: string;
+  result?: FetchRecordingsResult;
+};
+
+export type FetchRecordingsResult = {
+  total_recordings: number;
+  from: number;
+  limit: number;
+  order_by: string;
+  recordings_list: Array<RecordingInfo>;
+};
+
+export type RecordingInfo = {
+  record_id: string;
+  room_id: string;
+  room_sid: string;
+  file_path: string;
+  file_size: number;
+  creation_time: number;
+  room_creation_time: number;
+};

package/src/types/isRoomActive.ts

@@ -0,0 +1,8 @@
+export type IsRoomActiveParams = {
+  room_id: string;
+};
+
+export type IsRoomActiveResponse = {
+  status: boolean;
+  msg: string;
+};

package/src/types/joinToken.ts

@@ -0,0 +1,25 @@
+import { LockSettingsParams } from './createRoom';
+
+export type JoinTokenParams = {
+  room_id: string;
+  user_info: JoinTokenUserInfo;
+};
+
+export type JoinTokenUserInfo = {
+  name: string;
+  user_id: string;
+  is_admin: boolean;
+  is_hidden: boolean;
+  user_metadata?: JoinTokenUserMetadata;
+};
+
+export type JoinTokenUserMetadata = {
+  profile_pic?: string;
+  lock_settings?: LockSettingsParams;
+};
+
+export type JoinTokenResponse = {
+  status: boolean;
+  msg: string;
+  token?: string;
+};