@reactoo/watchtogether-sdk-js 2.5.35 → 2.5.39

package/src/models/room-session.js

@@ -1,6 +1,6 @@
 'use strict';
 
-import {wait} from "../modules/wt-utils";
+import {decodeJanusDisplay, wait} from "../modules/wt-utils";
 import _emitter_ from "../modules/wt-emitter";
 
 // SYNCHRONISATION MODULES
@@ -17,7 +17,7 @@ import syncDisabled from "../modules/sync-modules/sync-disabled";
 import syncDaznDash from "../modules/sync-modules/sync-dazn-dash";
 import syncUniversal from "../modules/sync-modules/sync-universal";
 
-let roomSession = function ({roomId, pinHash, isTalkback, isMonitor, isInstructor}, room, wt) {
+let roomSession = function ({roomId, pinHash, role}, room, wt) {
 
 	let primaryRoomId = roomId;
 	let publicCustomEvents = ['changePlayerSource', 'chatMessage', 'userUpdate', 'reconnecting', 'connecting', 'remoteMuted', 'scaling'];
@@ -88,27 +88,33 @@ let roomSession = function ({roomId, pinHash, isTalkback, isMonitor, isInstructo
 			emitter.emit('connecting', true);
 			clearTimeout(alpTimeoutId);
 			abortController = new AbortController();
-			return Promise.all([wt.room.__joinRoom({
+			return wt.room.__joinRoom({
 				roomId: reactooRoomId || primaryRoomId,
 				pinHash,
-				isTalkback,
-				isMonitor,
-				isInstructor
-			}, abortController?.signal), wt.user.getUserSelf()])
-				.then(([roomData, userData]) => {
+				role
+			}, abortController?.signal)
+				.then(roomData => {
 					// Happens when we reroute user to a different room
 					if(roomData?.data?.reactooRoomId !== roomId) {
 						roomId = roomData.data.reactooRoomId;
 						emitter.emit('changeRoomId', roomId);
 					}
-					return Promise.all([roomData, userData])
+					room.setRoomType(roomData.data.roomType);
+					return room.connect(
+						roomData.data.roomId,
+						roomData.data.pin,
+						roomData.data.href,
+						roomData.data.iceServers,
+						roomData.data.accessToken,
+						roomData.data.display,
+						roomData.data.userId,
+						roomData.data.webrtcVersion,
+						(roomData.data.bitrate ? parseInt(roomData.data.bitrate) : 0),
+						roomData.data.recordingFilename)
 				})
-				.then(([roomData, userData]) => Promise.all([roomData, userData, this.setRoomVars()]))
-				.then(([roomData, userData, _]) => Promise.all([roomData, userData, room.connect(roomData.data.roomId, roomData.data.pin, roomData.data.href, roomData.data.iceServers, roomData.data.accessToken, roomData.data.display, roomData.data.userId, roomData.data.webrtcVersion, (roomData.data.bitrate ? parseInt(roomData.data.bitrate) : 0), isMonitor, roomData.data.recordingFilename)]))
 				.finally(() => {
 					emitter.emit('connecting', false);
 				})
-
 		},
 
 		disconnect: function (dontWaitForResponses) {
@@ -172,17 +178,13 @@ let roomSession = function ({roomId, pinHash, isTalkback, isMonitor, isInstructo
 					this.restart();
 				} else if (msg.action === 'user_update_displayname' || msg.action === 'user_update_avatar' || msg.action === 'user_update_customattributes' || msg.action === 'user_update_privateattributes') {
 					emitter.emit('userUpdate', msg.text);
-				} else if (msg.action === 'observer_connecting' || msg.action === 'talkback_connecting' || msg.action === 'instructor_connecting') {
-					this.setRoomVars().catch(e => {
-						room._log('Setting observers failed, this will cause issues', e);
-					});
 				} else if (msg.action === 'bitrate_changed') {
 					this.setBitrateCap(msg.text);
 				} else if (msg.user_action === 'chat_message') {
 					emitter.emit('chatMessage', msg);
 				} else if (msg.user_action === 'remote_muted') {
 					if (msg.from !== room.userId) {
-						emitter.emit('remoteMuted', {userId: msg.from, ...(msg.text && JSON.parse(msg.text))})
+						emitter.emit('remoteMuted', {userId: decodeJanusDisplay(msg.from)?.userId, ...(msg.text && JSON.parse(msg.text))})
 					}
 				} else if (msg.user_action === 'remote_muted_request') {
 					if (msg.from !== room.userId) {
@@ -289,16 +291,6 @@ let roomSession = function ({roomId, pinHash, isTalkback, isMonitor, isInstructo
 			}
 		},
 
-		setRoomVars: () => {
-			return wt.room.getRoomById(roomId, pinHash, undefined, false, abortController?.signal)
-				.then(r => {
-					// setting observers userId's so we can ignore them when creating participant
-					room.setObserverIds(r.data.allowedObservers);
-					room.setTalkbackIds(r.data.allowedTalkbacks);
-					room.setInstructorId(r.data.classroom?.instructorUserId);
-				});
-		},
-
 		publishLocal: function (stream = null, {keepAudio = false, keepVideo = false} = {}) {
 			return room.publishLocal(stream, {keepAudio, keepVideo})
 		},
@@ -316,11 +308,9 @@ let roomSession = function ({roomId, pinHash, isTalkback, isMonitor, isInstructo
 		},
 
 		setBitrateCap: (bitrate) => {
-
-			if(isInstructor) {
+			if(role === 'host') {
 				return;
 			}
-
 			return room.sendMessage(room.handleId, {
 				"body": {
 					"request": "configure",
@@ -329,19 +319,6 @@ let roomSession = function ({roomId, pinHash, isTalkback, isMonitor, isInstructo
 			}).catch(() => null)
 		},
 
-		switchChannel: (channelId) => {
-			return room.sendMessage(room.handleId, {
-				body: {
-					request: "sync_source_set",
-					room: room.roomId,
-					timestamp: new Date().getTime(),
-					wt_channel_id: channelId,
-					fragment: "0",
-					fragment_pos: 0
-				}
-			});
-		},
-
 		sendSystemMessage: (action, value = {}, to, set_master) => {
 			return room.sendMessage(room.handleId, {
 				body: {

package/src/models/room.js

@@ -205,15 +205,13 @@ let room = function () {
 				}))
 		},
 
-		__joinRoom: ({roomId, pinHash, instanceType = this.__instanceType, isTalkback = undefined, isMonitor = undefined, isInstructor = undefined, customBearer = undefined} = {}, signal) => {
+		__joinRoom: ({roomId, pinHash, instanceType = this.__instanceType, role = 'participant', customBearer = undefined} = {}, signal) => {
 			return this.__privates.auth.__client
 				.then(client => client.apis.wt.join({
 					roomId,
 					pinHash,
 					instanceType,
-					isTalkback,
-					isMonitor,
-					isInstructor,
+					role,
 					platform: this.browser === 'firefox' ? 'web-firefox' : 'web'
 				}, {
 					...(signal ? {
@@ -246,10 +244,11 @@ let room = function () {
 				.then(newSession => {
 					let existingSessionIndex = roomSessions.findIndex(session => session.constructId === newSession.constructId);
 					if(existingSessionIndex > -1) {
-						return this.room.destroySession(newSession.constructId).then(() => {
-							roomSessions.push(newSession);
-							return newSession;
-						});
+						return this.room.destroySession(newSession.constructId)
+							.then(() => {
+								roomSessions.push(newSession);
+								return newSession;
+							});
 					} else {
 						roomSessions.push(newSession);
 						return newSession;
@@ -257,22 +256,21 @@ let room = function () {
 				})
 		},
 
-		createSession: ({constructId, roomId, pinHash, isTalkback, isMonitor, isInstructor, options}) => {
+		createSession: ({constructId, roomId, pinHash, role, options}) => {
 			return this.__privates.room.whenInitialized
 				.then(lib => roomSession.call(this, {
 					roomId,
 					pinHash,
-					isTalkback,
-					isMonitor,
-					isInstructor
+					role,
 				}, lib.createSession(constructId, 'reactooroom', options), this))
 				.then(newSession => {
 					let existingSessionIndex = roomSessions.findIndex(session => session.constructId === newSession.constructId);
 					if(existingSessionIndex > -1) {
-						return this.room.destroySession(newSession.constructId).then(() => {
-							roomSessions.push(newSession);
-							return newSession;
-						});
+						return this.room.destroySession(newSession.constructId)
+							.then(() => {
+								roomSessions.push(newSession);
+								return newSession;
+							});
 					} else {
 						roomSessions.push(newSession);
 						return newSession;

package/src/modules/wt-iot.js

@@ -1,6 +1,7 @@
 
 import {device} from 'aws-iot-device-sdk';
 import emitter from './wt-emitter';
+import {decodeJanusDisplay} from "./wt-utils";
 
 class Iot {
     
@@ -68,14 +69,14 @@ class Iot {
                 this.startCredentialsExpirationCheck(expiration);
                 
                 let __s = () => {
-                    this.device.off('connect', __s);
-                    this.device.off('error', __e);
+                    this.device?.off('connect', __s);
+                    this.device?.off('error', __e);
                     resolve(this.device)
                 };
                 
                 let __e = (e) => {
-                    this.device.off('connect', __s);
-                    this.device.off('error', __e);
+                    this.device?.off('connect', __s);
+                    this.device?.off('error', __e);
                     reject(e);
                 };
                 
@@ -156,10 +157,16 @@ class Iot {
     }
     
     __messageCb(t, message, packet) {
-        
         const topic = t.split('/');
-        const payload = JSON.parse(this.decoder.decode(message));
-        
+        let payload = JSON.parse(this.decoder.decode(message));
+
+        if(payload.display) {
+            const decodedDisplay = decodeJanusDisplay(payload.display);
+            if(decodedDisplay.userId) {
+                payload = {...payload, userId: decodedDisplay.userId}
+            }
+        }
+
         if(topic[0] === 'user') { // user
             const userId = topic[1].replace("_", ':');
             this.emit('message', {userId, ...payload, event: payload.event ? `user:${payload.event}` : 'user'});

package/src/modules/wt-room.js

@@ -2,7 +2,7 @@
 
 import adapter from 'webrtc-adapter';
 import emitter from './wt-emitter';
-import {generateUUID} from "./wt-utils";
+import {decodeJanusDisplay, generateUUID} from "./wt-utils";
 
 class Room {
 
@@ -96,25 +96,42 @@ class RoomSession {
 
 	static subscriptionRules = {
 		participant: {
-			watchTogether: ['participant', 'talkback'],
-			videoWall: ['instructor', 'observer', 'talkback']
+			"watchparty": ['participant', 'talkback'],
+			"commentary": ['participant', 'talkback'],
+			"videowall": ['host', 'observer', 'talkback'],
+			"videowall-queue": ['host', 'observer', 'talkback'],
+			"videowall-queue-video": ['host', 'observer', 'talkback']
 		},
 		monitor: {
-			watchTogether: ['participant'],
-			videoWall: ['instructor', 'participant'],
+			"watchparty": ['participant'],
+			"commentary": ['participant'],
+			"videowall": ['host', 'participant'],
+			"videowall-queue": ['host', 'participant'],
+			"videowall-queue-video": ['host', 'participant'],
 		},
 		talkback: {
-			watchTogether: ['participant'],
-			videoWall: ['instructor', 'participant'],
+			"watchparty": ['participant'],
+			"commentary": ['participant'],
+			"videowall": ['host', 'participant'],
+			"videowall-queue": ['host', 'participant'],
+			"videowall-queue-video": ['host', 'participant'],
 		},
 		observer: {
-			watchTogether: ['participant'],
-			videoWall: ['participant'],
+			"watchparty": ['participant'],
+			"commentary": ['participant'],
+			"videowall": ['participant'],
+			"videowall-queue": ['participant'],
+			"videowall-queue-video": ['participant'],
 		},
-		instructor: {
-			watchTogether: [],
-			videoWall: [],
+		host: {
+			"watchparty": [],
+			"commentary": [],
+			"videowall": [],
+			"videowall-queue": [],
+			"videowall-queue-video": [],
 		},
+		companionTV: {},
+		companionPhone: {},
 	};
 
 	constructor(constructId = null, type = 'reactooroom', options = {}) {
@@ -130,8 +147,6 @@ class RoomSession {
 		this.userId = null;
 		this.sessiontype = type;
 		this.initialBitrate = 0;
-		//TODO: remove this
-		this.isMonitor = false; // currently used just for classroom context so monitor user only subscribes to participants and not trainer (for other monitor this flag is not necessary)
 		this.recordingFilename = null;
 		this.pluginName = RoomSession.sessionTypes[type];
 		this.options = options;
@@ -155,9 +170,7 @@ class RoomSession {
 		this._maxRetries = 3;
 		this._keepAliveId = null;
 		this._participants = [];
-		this._observerIds = [];
-		this._talkbackIds = [];
-		this._instuctorId = null;
+		this._roomType = 'watchparty';
 		this._isDataChannelOpen = false;
 		this._abortController = null;
 
@@ -209,29 +222,11 @@ class RoomSession {
 	}
 
 	_participantShouldSubscribe(userId) {
-		let allowedObservers = this._observerIds || [];
-		let allowedTalkback = this._talkbackIds || [];
-		let allowedInstructor = this._instuctorId || null;
-		let localUserRole = 'participant';
-		if(this.isMonitor) {
-			localUserRole = 'monitor';
-		} else if(allowedObservers.indexOf(this.userId) > -1) {
-			localUserRole = 'observer';
-		} else if(allowedTalkback.indexOf(this.userId) > -1) {
-			localUserRole = 'talkback';
-		} else if(this.userId === allowedInstructor) {
-			localUserRole = 'instructor';
-		}
-		let remoteUserRole = 'participant';
-		if(allowedObservers.indexOf(userId) > -1) {
-			remoteUserRole = 'observer';
-		} else if(allowedTalkback.indexOf(userId) > -1) {
-			remoteUserRole = 'talkback';
-		} else if(userId === allowedInstructor) {
-			remoteUserRole = 'instructor';
-		}
-		let mode = allowedInstructor !== null ? 'videoWall' : 'watchTogether';
-		return this.subscriptionRules[localUserRole][mode].indexOf(remoteUserRole) > -1;
+		const myUser = decodeJanusDisplay(this.display);
+		const remoteUser = decodeJanusDisplay(userId);
+		let localUserRole = myUser?.role || 'participant';
+		let remoteUserRole = remoteUser?.role || 'participant';
+		return this.subscriptionRules[localUserRole][(this._roomType || 'watchparty')].indexOf(remoteUserRole) > -1;
 	}
 
 	_getAddParticipantEventName(handleId) {
@@ -246,20 +241,25 @@ class RoomSession {
 			});
 		}
 
-		let allowedTalkback = this._talkbackIds || [];
-		let allowedObservers = this._observerIds || [];
-		let allowedInstructor = this._instuctorId || null;
-		let eventName = 'addRemoteParticipant';
-		if(handle.userId === allowedInstructor) {
-			eventName = 'addRemoteInstructor';
-		}
-		if (allowedTalkback.indexOf(handle.userId) > -1) {
-			eventName = 'addRemoteTalkback';
+		const participantRole = decodeJanusDisplay(handle.userId)?.role;
+		switch (participantRole) {
+			case 'participant':
+				return 'addRemoteParticipant';
+			case 'talkback':
+				return 'addRemoteTalkback';
+			case 'monitor':
+				return 'addRemoteTalkback';
+			case 'observer':
+				return 'addRemoteObserver';
+			case 'host':
+				return 'addRemoteInstructor';
+			case 'companionTV':
+				return 'addRemoteCompanionTV';
+			case 'companionPhone':
+				return 'addRemoteCompanionPhone';
+			default:
+				return 'addRemoteParticipant';
 		}
-		if (allowedObservers.indexOf(handle.userId) > -1) {
-			eventName = 'addRemoteObserver';
-		}
-		return eventName
 	}
 
 	_getRemoveParticipantEventName(handleId) {
@@ -274,20 +274,25 @@ class RoomSession {
 			});
 		}
 
-		let allowedTalkback = this._talkbackIds || [];
-		let allowedObservers = this._observerIds || [];
-		let allowedInstructor = this._instuctorId || null;
-		let eventName = 'removeRemoteParticipant';
-		if(handle.userId === allowedInstructor) {
-			eventName = 'removeRemoteInstructor';
-		}
-		if (allowedTalkback.indexOf(handle.userId) > -1) {
-			eventName = 'removeRemoteTalkback';
+		const participantRole = decodeJanusDisplay(handle.userId)?.role;
+		switch (participantRole) {
+			case 'participant':
+				return 'removeRemoteParticipant';
+			case 'talkback':
+				return 'addRemoteTalkback';
+			case 'monitor':
+				return 'removeRemoteTalkback';
+			case 'observer':
+				return 'removeRemoteObserver';
+			case 'host':
+				return 'removeRemoteInstructor';
+			case 'companionTV':
+				return 'removeRemoteCompanionTV';
+			case 'companionPhone':
+				return 'removeRemoteCompanionPhone';
+			default:
+				return 'removeRemoteParticipant';
 		}
-		if (allowedObservers.indexOf(handle.userId) > -1) {
-			eventName = 'removeRemoteObserver';
-		}
-		return eventName
 	}
 
 	sendMessage(handleId, message = {body: 'Example Body'}, dontWait = false, dontResolveOnAck = false) {
@@ -658,7 +663,7 @@ class RoomSession {
 				this.emit(this._getAddParticipantEventName(handle.handleId), {
 					tid: generateUUID(),
 					id: handle.handleId,
-					userId: handle.userId,
+					userId: decodeJanusDisplay(handle.userId)?.userId,
 					stream: null,
 					track: null,
 					adding: false,
@@ -795,9 +800,9 @@ class RoomSession {
 					this._isDataChannelOpen = false;
 					this.isPublished = false;
 					this.emit('published', {status: false, hasStream: false});
-					this.emit('removeLocalParticipant', {id: handleId, userId: handle.userId});
+					this.emit('removeLocalParticipant', {id: handleId, userId: decodeJanusDisplay(handle.userId)?.userId});
 				} else {
-					this.emit(this._getRemoveParticipantEventName(handleId), {id: handleId, userId: handle.userId});
+					this.emit(this._getRemoveParticipantEventName(handleId), {id: handleId, userId: decodeJanusDisplay(handle.userId)?.userId});
 				}
 
 				if (removeHandle) {
@@ -928,7 +933,7 @@ class RoomSession {
 		});
 	}
 
-	connect(roomId, pin, server, iceServers, token, display, userId, webrtcVersion = 0, initialBitrate = 0, isMonitor, recordingFilename) {
+	connect(roomId, pin, server, iceServers, token, display, userId, webrtcVersion = 0, initialBitrate = 0, recordingFilename) {
 
 		if (this.isConnecting) {
 			return Promise.reject({type: 'warning', id: 16, message: 'connection already in progress'});
@@ -949,7 +954,6 @@ class RoomSession {
 		this.userId = userId;
 		this.webrtcVersion = webrtcVersion;
 		this.initialBitrate = initialBitrate;
-		this.isMonitor = isMonitor;
 		this.recordingFilename = recordingFilename;
 		this.isConnecting = true;
 		this.emit('joining', true);
@@ -1235,7 +1239,7 @@ class RoomSession {
 					this.emit(this._getAddParticipantEventName(handle.handleId), {
 						tid: generateUUID(),
 						id: handle.handleId,
-						userId: handle.userId,
+						userId: decodeJanusDisplay(handle.userId)?.userId,
 						stream: config.stream,
 						track: null,
 						optional: true,
@@ -1256,7 +1260,7 @@ class RoomSession {
 					this.emit(this._getAddParticipantEventName(handle.handleId), {
 						tid: generateUUID(),
 						id: handle.handleId,
-						userId: handle.userId,
+						userId: decodeJanusDisplay(handle.userId)?.userId,
 						stream: config.stream,
 						track: null,
 						optional: true,
@@ -1309,7 +1313,7 @@ class RoomSession {
 							tid: generateUUID(),
 							mid,
 							id: handle.handleId,
-							userId: handle.userId,
+							userId: decodeJanusDisplay(handle.userId)?.userId,
 							stream: config.stream,
 							track: event.track,
 							constructId: this.constructId,
@@ -1337,7 +1341,7 @@ class RoomSession {
 									tid: generateUUID(),
 									id: handle.handleId,
 									mid,
-									userId: handle.userId,
+									userId: decodeJanusDisplay(handle.userId)?.userId,
 									stream: config.stream,
 									track: ev.target,
 									constructId: this.constructId,
@@ -1363,7 +1367,7 @@ class RoomSession {
 							this.emit('remoteTrackMuted', {
 								id: handle.handleId,
 								mid,
-								userId: handle.userId,
+								userId: decodeJanusDisplay(handle.userId)?.userId,
 								stream: config.stream,
 								kind: ev.target.kind,
 								track: ev.target,
@@ -1384,7 +1388,7 @@ class RoomSession {
 							this.emit('remoteTrackMuted', {
 								id: handle.handleId,
 								mid,
-								userId: handle.userId,
+								userId: decodeJanusDisplay(handle.userId)?.userId,
 								stream: config.stream,
 								kind: ev.target.kind,
 								track: ev.target,
@@ -1988,7 +1992,7 @@ class RoomSession {
 							this.emit('addLocalParticipant', {
 								tid: generateUUID(),
 								id: handle.handleId,
-								userId: handle.userId,
+								userId: decodeJanusDisplay(handle.userId)?.userId,
 								track,
 								stream: config.stream,
 								adding: true,
@@ -2001,7 +2005,7 @@ class RoomSession {
 								this.emit('addLocalParticipant', {
 									tid:generateUUID(),
 									id: handle.handleId,
-									userId: handle.userId,
+									userId: decodeJanusDisplay(handle.userId)?.userId,
 									track: ev.target,
 									stream: config.stream,
 									adding: false,
@@ -2018,7 +2022,7 @@ class RoomSession {
 					this.emit('addLocalParticipant', {
 						tid: generateUUID(),
 						id: handle.handleId,
-						userId: handle.userId,
+						userId: decodeJanusDisplay(handle.userId)?.userId,
 						stream: null,
 						adding: false,
 						constructId: this.constructId,
@@ -2099,22 +2103,9 @@ class RoomSession {
 		this.emit('localMuted', {type: 'video', value: this.isVideoMuted, mid});
 	}
 
-	setInstructorId(instructorId = null) {
-		this._instuctorId = instructorId;
-		this.emit('instructorId', this._instuctorId);
-		return this._instuctorId;
-	}
-
-	setObserverIds(observerIds = []) {
-		this._observerIds = observerIds;
-		this.emit('observerIds', this._observerIds);
-		return this._observerIds;
-	}
-
-	setTalkbackIds(talkbackIds = []) {
-		this._talkbackIds = talkbackIds;
-		this.emit('talkbackIds', this._talkbackIds);
-		return this._talkbackIds;
+	setRoomType(type = 'watchparty') {
+		this._roomType = type;
+		return this._roomType;
 	}
 
 }

package/src/modules/wt-utils.js

@@ -27,6 +27,26 @@ let generateUUID = function () {
     });
 };
 
+
+const janusDisplayDelimiter = ',';
+const decodeJanusDisplay = display => {
+    let output = { userId: null, role: "participant", start: Date.now(), displayName: "?" };
+    if(display && typeof display === "string") {
+        if(display.indexOf(janusDisplayDelimiter) >= 0) {
+            let values = display
+                .split( new RegExp(`\\${janusDisplayDelimiter}(?=(?:(?:[^"]*"){2})*[^"]*$)`, 'mi') )
+                .map(v => (v && v.startsWith('"') || v.endsWith('"')) ? v.substring(1, v.length-1) : ( /^\d+$/.test(v) ? parseInt(v) : v ));
+            Object.keys(output).forEach((key, i) => values[i] ? output[key] = values[i] : null);
+        } else {
+            output.userId = display;
+        }
+        return output;
+    } else if(display && typeof display === "object") {
+        return Object.assign({}, output, display);
+    }
+    return null;
+}
+
 const setExactTimeout = function(callback, duration, resolution) {
     const start = (new Date()).getTime();
     const timeout = setInterval(function(){
@@ -43,4 +63,6 @@ const clearExactTimeout = function(timeout) {
     clearInterval(timeout);
 };
 
-export {wait, getBrowserFingerprint, generateUUID, setExactTimeout, clearExactTimeout}
+
+
+export {wait, getBrowserFingerprint, generateUUID, decodeJanusDisplay, setExactTimeout, clearExactTimeout}