plugnmeet-sdk-js 1.0.2 → 1.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/{PlugNmeet.d.ts → dist/PlugNmeet.d.ts} +0 -0
- package/dist/PlugNmeet.js +198 -0
- package/dist/PlugNmeet.js.map +1 -0
- package/{api.d.ts → dist/api.d.ts} +1 -1
- package/dist/api.js +67 -0
- package/dist/api.js.map +1 -0
- package/dist/cjs/PlugNmeet.d.ts +76 -0
- package/{PlugNmeet.js → dist/cjs/PlugNmeet.js} +1 -0
- package/dist/cjs/PlugNmeet.js.map +1 -0
- package/dist/cjs/api.d.ts +6 -0
- package/{api.js → dist/cjs/api.js} +1 -0
- package/dist/cjs/api.js.map +1 -0
- package/{index.d.ts → dist/cjs/index.d.ts} +1 -1
- package/{index.js → dist/cjs/index.js} +1 -0
- package/dist/cjs/index.js.map +1 -0
- package/dist/cjs/types/RecordingDownloadToken.d.ts +8 -0
- package/{types → dist/cjs/types}/RecordingDownloadToken.js +1 -0
- package/dist/cjs/types/RecordingDownloadToken.js.map +1 -0
- package/{types → dist/cjs/types}/activeRoomInfo.d.ts +5 -5
- package/{types → dist/cjs/types}/activeRoomInfo.js +1 -0
- package/dist/cjs/types/activeRoomInfo.js.map +1 -0
- package/{types → dist/cjs/types}/activeRoomsInfo.d.ts +1 -1
- package/{types → dist/cjs/types}/activeRoomsInfo.js +1 -0
- package/dist/cjs/types/activeRoomsInfo.js.map +1 -0
- package/{types → dist/cjs/types}/clientFiles.d.ts +1 -1
- package/{types → dist/cjs/types}/clientFiles.js +1 -0
- package/dist/cjs/types/clientFiles.js.map +1 -0
- package/{types → dist/cjs/types}/createRoom.d.ts +19 -13
- package/{types → dist/cjs/types}/createRoom.js +1 -0
- package/dist/cjs/types/createRoom.js.map +1 -0
- package/dist/cjs/types/deleteRecordings.d.ts +7 -0
- package/{types → dist/cjs/types}/deleteRecordings.js +1 -0
- package/dist/cjs/types/deleteRecordings.js.map +1 -0
- package/dist/cjs/types/endRoom.d.ts +7 -0
- package/{types → dist/cjs/types}/endRoom.js +1 -0
- package/dist/cjs/types/endRoom.js.map +1 -0
- package/{types → dist/cjs/types}/fetchRecordings.d.ts +4 -4
- package/{types → dist/cjs/types}/fetchRecordings.js +1 -0
- package/dist/cjs/types/fetchRecordings.js.map +1 -0
- package/dist/cjs/types/isRoomActive.d.ts +7 -0
- package/{types → dist/cjs/types}/isRoomActive.js +1 -0
- package/dist/cjs/types/isRoomActive.js.map +1 -0
- package/{types → dist/cjs/types}/joinToken.d.ts +4 -4
- package/{types → dist/cjs/types}/joinToken.js +1 -0
- package/dist/cjs/types/joinToken.js.map +1 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -0
- package/dist/types/RecordingDownloadToken.d.ts +8 -0
- package/dist/types/RecordingDownloadToken.js +2 -0
- package/dist/types/RecordingDownloadToken.js.map +1 -0
- package/dist/types/activeRoomInfo.d.ts +34 -0
- package/dist/types/activeRoomInfo.js +2 -0
- package/dist/types/activeRoomInfo.js.map +1 -0
- package/dist/types/activeRoomsInfo.d.ts +6 -0
- package/dist/types/activeRoomsInfo.js +2 -0
- package/dist/types/activeRoomsInfo.js.map +1 -0
- package/dist/types/clientFiles.d.ts +6 -0
- package/dist/types/clientFiles.js +2 -0
- package/dist/types/clientFiles.js.map +1 -0
- package/dist/types/createRoom.d.ts +82 -0
- package/dist/types/createRoom.js +2 -0
- package/dist/types/createRoom.js.map +1 -0
- package/dist/types/deleteRecordings.d.ts +7 -0
- package/dist/types/deleteRecordings.js +2 -0
- package/dist/types/deleteRecordings.js.map +1 -0
- package/dist/types/endRoom.d.ts +7 -0
- package/dist/types/endRoom.js +2 -0
- package/dist/types/endRoom.js.map +1 -0
- package/dist/types/fetchRecordings.d.ts +27 -0
- package/dist/types/fetchRecordings.js +2 -0
- package/dist/types/fetchRecordings.js.map +1 -0
- package/dist/types/isRoomActive.d.ts +7 -0
- package/dist/types/isRoomActive.js +2 -0
- package/dist/types/isRoomActive.js.map +1 -0
- package/dist/types/joinToken.d.ts +21 -0
- package/dist/types/joinToken.js +2 -0
- package/dist/types/joinToken.js.map +1 -0
- package/package.json +22 -12
- package/src/PlugNmeet.ts +255 -0
- package/src/api.ts +92 -0
- package/src/index.ts +48 -0
- package/src/types/RecordingDownloadToken.ts +9 -0
- package/src/types/activeRoomInfo.ts +38 -0
- package/src/types/activeRoomsInfo.ts +7 -0
- package/src/types/clientFiles.ts +6 -0
- package/src/types/createRoom.ts +94 -0
- package/src/types/deleteRecordings.ts +8 -0
- package/src/types/endRoom.ts +8 -0
- package/src/types/fetchRecordings.ts +30 -0
- package/src/types/isRoomActive.ts +8 -0
- package/src/types/joinToken.ts +25 -0
- package/types/RecordingDownloadToken.d.ts +0 -8
- package/types/deleteRecordings.d.ts +0 -7
- package/types/endRoom.d.ts +0 -7
- package/types/isRoomActive.d.ts +0 -7
|
@@ -1,22 +1,22 @@
|
|
|
1
|
-
export
|
|
1
|
+
export type FetchRecordingsParams = {
|
|
2
2
|
room_ids: Array<string>;
|
|
3
3
|
from?: number;
|
|
4
4
|
limit?: number;
|
|
5
5
|
order_by?: 'ASC' | 'DESC';
|
|
6
6
|
};
|
|
7
|
-
export
|
|
7
|
+
export type FetchRecordingsResponse = {
|
|
8
8
|
status: boolean;
|
|
9
9
|
msg: string;
|
|
10
10
|
result?: FetchRecordingsResult;
|
|
11
11
|
};
|
|
12
|
-
export
|
|
12
|
+
export type FetchRecordingsResult = {
|
|
13
13
|
total_recordings: number;
|
|
14
14
|
from: number;
|
|
15
15
|
limit: number;
|
|
16
16
|
order_by: string;
|
|
17
17
|
recordings_list: Array<RecordingInfo>;
|
|
18
18
|
};
|
|
19
|
-
export
|
|
19
|
+
export type RecordingInfo = {
|
|
20
20
|
record_id: string;
|
|
21
21
|
room_id: string;
|
|
22
22
|
room_sid: string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fetchRecordings.js","sourceRoot":"","sources":["../../../src/types/fetchRecordings.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isRoomActive.js","sourceRoot":"","sources":["../../../src/types/isRoomActive.ts"],"names":[],"mappings":""}
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
import { LockSettingsParams } from './createRoom';
|
|
2
|
-
export
|
|
2
|
+
export type JoinTokenParams = {
|
|
3
3
|
room_id: string;
|
|
4
4
|
user_info: JoinTokenUserInfo;
|
|
5
5
|
};
|
|
6
|
-
export
|
|
6
|
+
export type JoinTokenUserInfo = {
|
|
7
7
|
name: string;
|
|
8
8
|
user_id: string;
|
|
9
9
|
is_admin: boolean;
|
|
10
10
|
is_hidden: boolean;
|
|
11
11
|
user_metadata?: JoinTokenUserMetadata;
|
|
12
12
|
};
|
|
13
|
-
export
|
|
13
|
+
export type JoinTokenUserMetadata = {
|
|
14
14
|
profile_pic?: string;
|
|
15
15
|
lock_settings?: LockSettingsParams;
|
|
16
16
|
};
|
|
17
|
-
export
|
|
17
|
+
export type JoinTokenResponse = {
|
|
18
18
|
status: boolean;
|
|
19
19
|
msg: string;
|
|
20
20
|
token?: string;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"joinToken.js","sourceRoot":"","sources":["../../../src/types/joinToken.ts"],"names":[],"mappings":""}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
export { RooMetadata, CreateRoomParams, CreateRoomResponse, CreateRoomResponseRoomInfo, LockSettingsParams, RoomFeaturesParams, RecordingFeaturesParams, ChatFeaturesParams, SharedNotePadFeaturesParams, WhiteboardFeaturesParams, ExternalMediaPlayerFeatures, WaitingRoomFeatures, BreakoutRoomFeatures, } from './types/createRoom';
|
|
2
|
+
export { JoinTokenParams, JoinTokenResponse, JoinTokenUserMetadata, JoinTokenUserInfo, } from './types/joinToken';
|
|
3
|
+
export { IsRoomActiveParams, IsRoomActiveResponse } from './types/isRoomActive';
|
|
4
|
+
export { Room, ActiveRoomInfoParams, ActiveRoomInfoResponse, ParticipantInfo, ActiveRoomInfo, } from './types/activeRoomInfo';
|
|
5
|
+
export { ActiveRoomsInfoResponse } from './types/activeRoomsInfo';
|
|
6
|
+
export { EndRoomParams, EndRoomResponse } from './types/endRoom';
|
|
7
|
+
export { FetchRecordingsParams, FetchRecordingsResponse, FetchRecordingsResult, RecordingInfo, } from './types/fetchRecordings';
|
|
8
|
+
export { DeleteRecordingsParams, DeleteRecordingsResponse, } from './types/deleteRecordings';
|
|
9
|
+
export { RecordingDownloadTokenParams, RecordingDownloadTokenResponse, } from './types/RecordingDownloadToken';
|
|
10
|
+
export { ClientFilesResponse } from './types/clientFiles';
|
|
11
|
+
export { PlugNmeet } from './PlugNmeet';
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AA+CA,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"RecordingDownloadToken.js","sourceRoot":"","sources":["../../src/types/RecordingDownloadToken.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
export type ActiveRoomInfoParams = {
|
|
2
|
+
room_id: string;
|
|
3
|
+
};
|
|
4
|
+
export type ActiveRoomInfoResponse = {
|
|
5
|
+
status: boolean;
|
|
6
|
+
msg: string;
|
|
7
|
+
room?: Room;
|
|
8
|
+
};
|
|
9
|
+
export type Room = {
|
|
10
|
+
room_info: ActiveRoomInfo;
|
|
11
|
+
participants_info: Array<ParticipantInfo>;
|
|
12
|
+
};
|
|
13
|
+
export type ActiveRoomInfo = {
|
|
14
|
+
room_title: string;
|
|
15
|
+
room_id: string;
|
|
16
|
+
sid: string;
|
|
17
|
+
joined_participants: number;
|
|
18
|
+
is_running: boolean;
|
|
19
|
+
is_recording: boolean;
|
|
20
|
+
is_active_rtmp: boolean;
|
|
21
|
+
webhook_url: string;
|
|
22
|
+
creation_time: number;
|
|
23
|
+
metadata: string;
|
|
24
|
+
};
|
|
25
|
+
export type ParticipantInfo = {
|
|
26
|
+
sid: string;
|
|
27
|
+
identity: string;
|
|
28
|
+
state: string;
|
|
29
|
+
metadata: string;
|
|
30
|
+
joined_at: number;
|
|
31
|
+
name: string;
|
|
32
|
+
version: number;
|
|
33
|
+
permission: any;
|
|
34
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activeRoomInfo.js","sourceRoot":"","sources":["../../src/types/activeRoomInfo.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"activeRoomsInfo.js","sourceRoot":"","sources":["../../src/types/activeRoomsInfo.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"clientFiles.js","sourceRoot":"","sources":["../../src/types/clientFiles.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
export type CreateRoomParams = {
|
|
2
|
+
room_id: string;
|
|
3
|
+
max_participants?: number;
|
|
4
|
+
empty_timeout?: number;
|
|
5
|
+
metadata: RooMetadata;
|
|
6
|
+
};
|
|
7
|
+
export type RooMetadata = {
|
|
8
|
+
room_title: string;
|
|
9
|
+
welcome_message?: string;
|
|
10
|
+
webhook_url?: string;
|
|
11
|
+
room_features: RoomFeaturesParams;
|
|
12
|
+
default_lock_settings?: LockSettingsParams;
|
|
13
|
+
};
|
|
14
|
+
export type RoomFeaturesParams = {
|
|
15
|
+
allow_webcams: boolean;
|
|
16
|
+
mute_on_start: boolean;
|
|
17
|
+
allow_screen_share: boolean;
|
|
18
|
+
allow_rtmp: boolean;
|
|
19
|
+
admin_only_webcams: boolean;
|
|
20
|
+
allow_view_other_webcams: boolean;
|
|
21
|
+
allow_view_other_users_list: boolean;
|
|
22
|
+
recording_features: RecordingFeaturesParams;
|
|
23
|
+
chat_features: ChatFeaturesParams;
|
|
24
|
+
shared_note_pad_features?: SharedNotePadFeaturesParams;
|
|
25
|
+
whiteboard_features?: WhiteboardFeaturesParams;
|
|
26
|
+
external_media_player_features?: ExternalMediaPlayerFeatures;
|
|
27
|
+
waiting_room_features?: WaitingRoomFeatures;
|
|
28
|
+
breakout_room_features?: BreakoutRoomFeatures;
|
|
29
|
+
};
|
|
30
|
+
export type RecordingFeaturesParams = {
|
|
31
|
+
is_allow: boolean;
|
|
32
|
+
is_allow_cloud: boolean;
|
|
33
|
+
is_allow_local: boolean;
|
|
34
|
+
enable_auto_cloud_recording: boolean;
|
|
35
|
+
};
|
|
36
|
+
export type ChatFeaturesParams = {
|
|
37
|
+
allow_chat: boolean;
|
|
38
|
+
allow_file_upload: boolean;
|
|
39
|
+
allowed_file_types: Array<string>;
|
|
40
|
+
max_file_size: number;
|
|
41
|
+
};
|
|
42
|
+
export type SharedNotePadFeaturesParams = {
|
|
43
|
+
allowed_shared_note_pad: boolean;
|
|
44
|
+
};
|
|
45
|
+
export type WhiteboardFeaturesParams = {
|
|
46
|
+
allowed_whiteboard: boolean;
|
|
47
|
+
};
|
|
48
|
+
export type ExternalMediaPlayerFeatures = {
|
|
49
|
+
allowed_external_media_player: boolean;
|
|
50
|
+
};
|
|
51
|
+
export type WaitingRoomFeatures = {
|
|
52
|
+
is_active: boolean;
|
|
53
|
+
waiting_room_msg?: string;
|
|
54
|
+
};
|
|
55
|
+
export type BreakoutRoomFeatures = {
|
|
56
|
+
is_allow: boolean;
|
|
57
|
+
};
|
|
58
|
+
export type LockSettingsParams = {
|
|
59
|
+
lock_microphone?: boolean;
|
|
60
|
+
lock_webcam?: boolean;
|
|
61
|
+
lock_screen_sharing?: boolean;
|
|
62
|
+
lock_whiteboard?: boolean;
|
|
63
|
+
lock_shared_notepad?: boolean;
|
|
64
|
+
lock_chat?: boolean;
|
|
65
|
+
lock_chat_send_message?: boolean;
|
|
66
|
+
lock_chat_file_share?: boolean;
|
|
67
|
+
};
|
|
68
|
+
export type CreateRoomResponse = {
|
|
69
|
+
status: boolean;
|
|
70
|
+
msg: string;
|
|
71
|
+
roomInfo?: CreateRoomResponseRoomInfo;
|
|
72
|
+
};
|
|
73
|
+
export type CreateRoomResponseRoomInfo = {
|
|
74
|
+
sid: string;
|
|
75
|
+
name: string;
|
|
76
|
+
max_participants: number;
|
|
77
|
+
empty_timeout: number;
|
|
78
|
+
creation_time: number;
|
|
79
|
+
turn_password: string;
|
|
80
|
+
enabled_codecs: Array<any>;
|
|
81
|
+
metadata: string;
|
|
82
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"createRoom.js","sourceRoot":"","sources":["../../src/types/createRoom.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deleteRecordings.js","sourceRoot":"","sources":["../../src/types/deleteRecordings.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"endRoom.js","sourceRoot":"","sources":["../../src/types/endRoom.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
export type FetchRecordingsParams = {
|
|
2
|
+
room_ids: Array<string>;
|
|
3
|
+
from?: number;
|
|
4
|
+
limit?: number;
|
|
5
|
+
order_by?: 'ASC' | 'DESC';
|
|
6
|
+
};
|
|
7
|
+
export type FetchRecordingsResponse = {
|
|
8
|
+
status: boolean;
|
|
9
|
+
msg: string;
|
|
10
|
+
result?: FetchRecordingsResult;
|
|
11
|
+
};
|
|
12
|
+
export type FetchRecordingsResult = {
|
|
13
|
+
total_recordings: number;
|
|
14
|
+
from: number;
|
|
15
|
+
limit: number;
|
|
16
|
+
order_by: string;
|
|
17
|
+
recordings_list: Array<RecordingInfo>;
|
|
18
|
+
};
|
|
19
|
+
export type RecordingInfo = {
|
|
20
|
+
record_id: string;
|
|
21
|
+
room_id: string;
|
|
22
|
+
room_sid: string;
|
|
23
|
+
file_path: string;
|
|
24
|
+
file_size: number;
|
|
25
|
+
creation_time: number;
|
|
26
|
+
room_creation_time: number;
|
|
27
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fetchRecordings.js","sourceRoot":"","sources":["../../src/types/fetchRecordings.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"isRoomActive.js","sourceRoot":"","sources":["../../src/types/isRoomActive.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { LockSettingsParams } from './createRoom';
|
|
2
|
+
export type JoinTokenParams = {
|
|
3
|
+
room_id: string;
|
|
4
|
+
user_info: JoinTokenUserInfo;
|
|
5
|
+
};
|
|
6
|
+
export type JoinTokenUserInfo = {
|
|
7
|
+
name: string;
|
|
8
|
+
user_id: string;
|
|
9
|
+
is_admin: boolean;
|
|
10
|
+
is_hidden: boolean;
|
|
11
|
+
user_metadata?: JoinTokenUserMetadata;
|
|
12
|
+
};
|
|
13
|
+
export type JoinTokenUserMetadata = {
|
|
14
|
+
profile_pic?: string;
|
|
15
|
+
lock_settings?: LockSettingsParams;
|
|
16
|
+
};
|
|
17
|
+
export type JoinTokenResponse = {
|
|
18
|
+
status: boolean;
|
|
19
|
+
msg: string;
|
|
20
|
+
token?: string;
|
|
21
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"joinToken.js","sourceRoot":"","sources":["../../src/types/joinToken.ts"],"names":[],"mappings":""}
|
package/package.json
CHANGED
|
@@ -1,26 +1,36 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "plugnmeet-sdk-js",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.2.1",
|
|
4
4
|
"description": "plugNmeet JS SDK",
|
|
5
|
-
"
|
|
5
|
+
"author": "Jibon L. Costa",
|
|
6
|
+
"license": "MIT",
|
|
7
|
+
"module": "./dist/index.js",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
|
+
"exports": {
|
|
10
|
+
"types": "./dist/src/index.d.ts",
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"require": "./dist/cjs/index.js"
|
|
13
|
+
},
|
|
14
|
+
"files": [
|
|
15
|
+
"dist",
|
|
16
|
+
"src"
|
|
17
|
+
],
|
|
6
18
|
"scripts": {
|
|
7
19
|
"start": "rm -rf ./dist && concurrently -c \"red,green\" --kill-others \"tsc --watch -p . --outDir ./dist && esw -w --ext '.ts','.js' --fix\"",
|
|
8
|
-
"build": "rm -rf ./dist && tsc -p .
|
|
20
|
+
"build": "rm -rf ./dist && tsc -p tsconfig.json && tsc -p tsconfig-cjs.json",
|
|
9
21
|
"build-docs": "typedoc --sort source-order"
|
|
10
22
|
},
|
|
11
|
-
"author": "Jibon L. Costa",
|
|
12
|
-
"license": "MIT",
|
|
13
23
|
"devDependencies": {
|
|
14
|
-
"@types/node": "18.
|
|
15
|
-
"@typescript-eslint/eslint-plugin": "5.
|
|
16
|
-
"@typescript-eslint/parser": "5.
|
|
17
|
-
"concurrently": "7.
|
|
18
|
-
"eslint": "8.
|
|
24
|
+
"@types/node": "18.11.9",
|
|
25
|
+
"@typescript-eslint/eslint-plugin": "5.43.0",
|
|
26
|
+
"@typescript-eslint/parser": "5.43.0",
|
|
27
|
+
"concurrently": "7.5.0",
|
|
28
|
+
"eslint": "8.28.0",
|
|
19
29
|
"eslint-config-prettier": "8.5.0",
|
|
20
30
|
"eslint-plugin-prettier": "4.2.1",
|
|
21
31
|
"eslint-watch": "8.0.0",
|
|
22
32
|
"prettier": "2.7.1",
|
|
23
|
-
"typedoc": "0.23.
|
|
24
|
-
"typescript": "4.
|
|
33
|
+
"typedoc": "0.23.21",
|
|
34
|
+
"typescript": "4.9.3"
|
|
25
35
|
}
|
|
26
36
|
}
|