@jibb-open/jssdk 3.5.5

package/src/api/eventbus.js

@@ -0,0 +1,246 @@
+import {Auth} from './auth.js';
+import {Config} from '../config.js'
+import {http} from "../utils/http/index.js"
+
+/**
+ * EventBus.
+ * @module EventBus
+ * 
+ * 
+ */
+
+/**
+ *
+ * @async
+ * @param {string} clientId
+ * @returns {array} - list of available camera, each camera is an object of with id and name properties.
+ */
+export async function getCameraList(clientId) {
+	let response = await http.get(
+		`${Config.apiBaseURL}/v1/eventbus/clients/${clientId}/cameras`,
+		await _prepareRequestHeaders()
+	)
+	return response.data.items
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {object} param0.cameraId
+ * @param {object} param0.clientId
+ * @returns {data}
+ */
+export async function getCameraPreview({ cameraId, clientId }) {
+	let body = {
+		source: {
+			id: cameraId,
+		},
+	}
+	let response = await http.post(
+		`${Config.apiBaseURL}/v1/eventbus/${clientId}/preview`,
+		body,
+		await _prepareRequestHeaders()
+	)
+	return response.data.image
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.meeting_token
+ * @param {string} param0.surfaceType - PAPER or WHITEBOARD
+ * @param {string} [param0.cameraId] - either sipUri or cameraId should be specified.
+ * @param {string} [param0.sipUri] - either sipUri or cameraId should be specified.
+ * @param {boolean} [param0.flipLeftRight=false] - mirror output stream.
+ * @param {boolean} [param0.flipUpDown=false] - mirror vertically  output stream.
+ * @param {number} [param0.rotation=0] - output rotation degree 0, 90, 180, 270.
+ * @param {boolean} [param0.fixedCorners=fales] - enable srufcae fixed corners after first detection.
+ * @param {string} param0.clientId
+ * @param {array} [param0.customCorners] - array of 8 Numbers ranged from 0-1 that decribe 4 points based on percentage [x1, y1, x2, y2 ...] example [0.1, 0.1, 0.8, 0.1, 0.1, 0.8, 0.8 ,0.8]
+ * @param {boolean} [param0.enableColor]
+ * @param {boolean} [param0.enableEstimation]
+ * @returns - http result
+ */
+export async function startStream({
+	meetingId,
+	meetingToken,
+	surfaceType,
+	cameraId,
+	sipUri,
+	flipLeftRight,
+	flipUpDown,
+	rotation,
+	fixedCorners,
+	clientId,
+	customCorners,
+	enableColor,
+	enableEstimation,
+}) {
+	let request = {
+		config: {
+			surface_type: surfaceType,
+		},
+		app_config: {
+			meeting_id: meetingId,
+			meeting_token: meetingToken,
+		},
+		runtime_config: _makeRuntimeConfig({
+			fixedCorners,
+			flipLeftRight,
+			flipUpDown,
+			rotation,
+			customCorners,
+			enableColor,
+			enableEstimation,
+		}),
+	}
+
+	if (!cameraId && !sipUri) {
+		return Promise.reject(`Invalid request: either sipUri or cameraId should be specified`)
+	}
+	if (cameraId && sipUri) {
+		return Promise.reject(`Invalid request: both sipUri (${sipUri}) and cameraId (${sipUri}) are specified`)
+	} else if (sipUri) {
+		request["sip_uri"] = sipUri
+	} else {
+		request["camera"] = {
+			id: cameraId,
+		}
+	}
+
+	let body = {
+		start_request: request,
+	}
+
+	return http.post(`${Config.apiBaseURL}/v1/eventbus/clients/${clientId}/start`, body, await _prepareRequestHeaders())
+}
+
+//if there is no body I get error code:401 status:Unauthorized
+
+/**
+ *
+ * @async
+ * @param {string} clientId
+ * @returns  - http result
+ */
+export async function stopStream(clientId) {
+	let body = {}
+	return http.post(`${Config.apiBaseURL}/v1/eventbus/${clientId}/stop`, body, await _prepareRequestHeaders())
+}
+
+// the only decent solution that comes to my mind is using body as parameter,
+//other one is having all possible events as paramaters ( more than 13) and then check for null and build the body like jibb.startStream.
+// we can send grpc event data but then client need to have the grpc file and complie it.
+
+/**
+ *
+ * @async
+ * @param {string} body
+ * @returns - http result.
+ */
+export async function sendMessage(body) {
+	return http.post(`${Config.apiBaseURL}/v1/eventbus`, body, await _prepareRequestHeaders())
+}
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {boolean} [param0.flipLeftRight=false] - mirror output stream.
+ * @param {boolean} [param0.flipUpDown=false] - mirror vertically  output stream.
+ * @param {number} [param0.rotation=0] - output rotation degree 0, 90, 180, 270.
+ * @param {boolean} [param0.fixedCorners=fales] - enable srufcae fixed corners after first detection.
+ * @param {string} param0.clientId
+ * @param {array} [param0.customCorners] - array of 8 Numbers ranged from 0-1 that decribe 4 points based on percentage [x1, y1, x2, y2 ...] example [0.1, 0.1, 0.8, 0.1, 0.1, 0.8, 0.8 ,0.8]
+ * @param {boolean} [param0.enableColor]
+ * @param {boolean} [param0.enableEstimation]
+ * @returns - http result.
+ */
+export async function setRuntimeConfig({
+	flipLeftRight,
+	flipUpDown,
+	rotation,
+	fixedCorners,
+	customCorners,
+	clientId,
+	enableColor,
+	enableEstimation,
+}) {
+	let body = {
+		runtime_config_request: {
+			runtime_config: _makeRuntimeConfig({
+				fixedCorners,
+				flipLeftRight,
+				flipUpDown,
+				rotation,
+				customCorners,
+				enableColor,
+				enableEstimation,
+			}),
+		},
+	}
+
+	return http.post(`${Config.apiBaseURL}/v1/eventbus/${clientId}/runtime_config`, body, await _prepareRequestHeaders())
+}
+
+/**
+ *
+ *
+ * @async
+ * @returns {array} - list of connected clients, each clinet is an object with id and type property
+ */
+export async function getClientStatusList() {
+	let response = await http.get(`${Config.apiBaseURL}/v1/eventbus/clients`, await _prepareRequestHeaders())
+
+	return response.data.clients
+}
+
+async function _prepareRequestHeaders() {
+	return {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+}
+
+function _makeRuntimeConfig({
+	fixedCorners,
+	flipLeftRight,
+	flipUpDown,
+	rotation,
+	customCorners,
+	enableColor,
+	enableEstimation,
+}) {
+	switch (rotation) {
+		case 90:
+			rotation = "1"
+			break
+		case 180:
+		case -180:
+			rotation = "2"
+			break
+		case -90:
+		case 270:
+			rotation = "3"
+			break
+		case 0:
+		case 360:
+		default:
+			rotation = "0"
+			break
+	}
+
+	return {
+		custom_corners: customCorners || [],
+		rotation: rotation,
+		enable_color: enableColor || false,
+		fixed_corners: fixedCorners,
+		enable_estimation: enableEstimation || false,
+		flip_up_down: flipUpDown || false,
+		flip_left_right: flipLeftRight || false,
+	}
+}
+

package/src/api/index.js

@@ -0,0 +1,26 @@
+import * as WebexBot from "./webexbot.js"
+import * as Meeting from "./meeting.js"
+import * as SuperAdmin from "./superadmin.js"
+import * as Admin from "./admin.js"
+import * as User from "./user.js"
+import {Auth} from "./auth.js"
+import {Whiteboard} from "./whiteboard.js"
+import * as EventBus from "./eventbus.js"
+import * as Recording from "./recording.js"
+import {initPinoLogger} from "../utils/logger/index.js"
+
+initPinoLogger()
+
+export {WebexBot, Meeting, Auth, User, Admin, SuperAdmin, Recording, Whiteboard, EventBus}
+
+export default {
+	WebexBot,
+	Meeting,
+	Auth,
+	User,
+	Admin,
+	SuperAdmin,
+	Recording,
+	Whiteboard,
+	EventBus,
+}

package/src/api/meeting.js

@@ -0,0 +1,421 @@
+import {Config} from "../config.js"
+import {Auth} from "./auth.js"
+import {logger} from "../utils/logger/index.js"
+import {NotFoundError, PermissionDeniedError} from "../types/exceptions.js"
+import {http} from "../utils/http/index.js"
+import {UserClaims, MeetingClaims, MeetingTypes} from "../types/types.js"
+
+/**
+ *
+ * @module meeting
+ *
+ */
+
+/**
+ *
+ * @async
+ * @param {Object} param0
+ * @param {string} [param0.title=""] - meeting title.
+ * @param {boolean} [param0.isTemporary=false]  - meeting won't be saved in dashboard.
+ * @param {Number} [param0.capacity=2] - 1 or 2 , number of allowed stream to the meeting.
+ * @param {Number} [param0.meetingType=0] - 0 DEFAULT or 1 WHITEBOARD
+ * @returns {string} - ID of created meeting
+ */
+export async function createMeeting({title, isTemporary, capacity, meetingType}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+	let body = {
+		title: title || "",
+		isTemporary: isTemporary || false,
+		capacity: capacity || 2,
+		meetingType: meetingType || MeetingTypes.DEFAULT,
+	}
+	let response = await http.post(`${Config.apiBaseURL}/v1/meetings`, body, headers)
+	return response.data.meetingId
+}
+
+/**
+ *
+ * @export export async function function 
+ * @param {object} param0
+ * @param {string} param0.meetingId - meeting ID.
+ * @param {Number} param0.permission - 1 Read or 2 Write.
+ * @param {Number} [param0.expiry=3600] - share time expiry in seconds.
+ * @param {object} [param0.auxData={}] - object that can be used to include specific data in meeting share like call ID for this share.
+ * @returns {string} - shareId
+ */
+export async function createTemporaryShare({meetingId, permission, expiry, auxData}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+	let body = {
+		permission: permission,
+		expiry: {
+			seconds: expiry || 3600,
+		},
+		auxilary: auxData || {},
+	}
+
+	let response = await http.post(`${Config.apiBaseURL}/v1/meetings/${meetingId}/temp-shares`, body, headers)
+	return response.data.shareId
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.shareId
+ * @returns {string} - token
+ */
+export async function getMeetingTokenFromTempShareId({meetingId, shareId}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/meetings/${meetingId}/temp-shares/${shareId}`, headers)
+	return response.data.token
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.mtoken
+ * @returns - http response
+ */
+export async function deleteMeetingImages({meetingId, mtoken}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+		"x-jibb-meeting-jwt": mtoken,
+	}
+
+	return http.delete(`${Config.apiBaseURL}/v1/meetings/${meetingId}/images`, headers)
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.meetingToken
+ * @returns {Array} - list of images
+ */
+export async function getMeetingImages({meetingId, meetingToken}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+		"x-jibb-meeting-jwt": meetingToken,
+	}
+
+	let response = await http.get(`${Config.apiBaseURL}/v1/meetings/${meetingId}/images`, headers)
+	return response.data
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.meetingToken
+ * @param {string} param0.imageId
+ * @returns {data} - base64 data
+ */
+export async function getMeetingImage({meetingId, meetingToken, imageId}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+		"x-jibb-meeting-jwt": meetingToken,
+	}
+
+	let response = await http.get(`${Config.apiBaseURL}/v1/meetings/${meetingId}/images/${imageId}`, headers)
+	return response.data
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.meetingToken
+ * @returns - http response
+ */
+export async function startMeeting({meetingId, meetingToken}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-meeting-jwt": meetingToken,
+	}
+
+	try {
+		let body = {}
+		return await http.post(`${Config.apiBaseURL}/v1/meetings/${meetingId}/actions/start`, body, headers)
+	} catch (e) {
+		if (e?.response?.status == 404) throw new NotFoundError()
+		else throw e
+	}
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.meetingToken
+ * @returns - http response
+ */
+export async function endMeeting({meetingId, meetingToken}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-meeting-jwt": meetingToken,
+	}
+	let body = {}
+	return http.post(`${Config.apiBaseURL}/v1/meetings/${meetingId}/actions/end`, body, headers)
+}
+
+/**
+ *
+ * @async
+ * @param {string} meetingId
+ * @returns - http response
+ */
+export async function deleteMeeting(meetingId) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+	return http.delete(`${Config.apiBaseURL}/v1/meetings/${meetingId}`, headers)
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {Number} param0.permission - 1 Read or 2 Write.
+ * @param {Number} [param0.expiry=3600] - share time expiry in seconds.
+ * @returns {string} - token
+ */
+export async function getMeetingToken({meetingId, permission, expiry = 3600}) {
+	let userToken
+
+	try {
+		userToken = await Auth.getUserToken()
+	} catch (err) {
+		logger.error({
+			err,
+		})
+		throw new PermissionDeniedError("user is not authenticated")
+	}
+
+	try {
+		let headers = {
+			"Content-Type": "application/json",
+			Accept: "application/json",
+			"x-jibb-user-jwt": userToken,
+		}
+		let response = await http.get(
+			`${Config.apiBaseURL}/v1/meetings/${meetingId}/token/${permission}?expiry.seconds=${expiry}`,
+
+			headers
+		)
+		return response.data.token
+	} catch (err) {
+		if (err?.response?.status == 404) throw new NotFoundError("meeting not found")
+		else throw err
+	}
+}
+
+/**
+ *
+ * @async
+ * @param {*} pagination
+ * @returns {Array} - meeting list.
+ */
+export async function getMeetingList(pagination) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+	if (pagination !== undefined) headers["x-jibb-pagination"] = JSON.stringify(pagination)
+	let response = await http.get(`${Config.apiBaseURL}/v1/meetings`, headers)
+	pagination = response.headers["x-jibb-pagination"]
+	pagination = pagination && JSON.parse(pagination)
+
+	return {
+		meetings: response.data.meetings,
+		pagination: pagination,
+	}
+}
+
+/**
+ *
+ * @async
+ * @param {string} meetingId
+ * @returns {object} - object with meeting details.
+ */
+export async function getMeetingDetails(meetingId) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+
+	let response = await http.get(`${Config.apiBaseURL}/v1/meetings/${meetingId}`, headers)
+	return response.data
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.title
+ * @param {Number} param0.capacity
+ * @returns - http result
+ */
+export async function updateMeeting({meetingId, title, capacity}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+
+	let body = {}
+	if (title) {
+		body["title"] = title
+	}
+	if (capacity) {
+		body["capacity"] = capacity
+	}
+
+	return http.post(`${Config.apiBaseURL}/v1/meetings/${meetingId}`, body, headers)
+}
+
+/**
+ *
+ * @async
+ * @param {string} meetingToken
+ * @returns {Boolean}
+ */
+export async function isMeetingOwner(meetingToken) {
+	try {
+		let meetingClaims = new MeetingClaims(meetingToken)
+		let userClaims = new UserClaims(await Auth.getUserToken())
+		return userClaims.email === meetingClaims.owner
+	} catch (err) {
+		return false
+	}
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.email
+ * @param {string} param0.meetingId
+ * @param {Number} param0.permission - 1 Read or 2 Write.
+ * @param {string} param0.meetingToken
+ * @returns {string}
+ */
+
+export async function createShare({email, meetingId, permission, meetingToken}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+		"x-jibb-meeting-jwt": meetingToken,
+	}
+	let body = {
+		email: email,
+		permission: permission,
+	}
+	let response = await http.post(`${Config.apiBaseURL}/v1/meetings/${meetingId}/shares`, body, headers)
+	return response.data
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.meetingToken
+ * @returns {list} - list of shares of this meeting
+ */
+export async function getListShare({meetingId, meetingToken}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+		"x-jibb-meeting-jwt": meetingToken,
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/meetings/${meetingId}/shares`, headers)
+
+	return response.data.shares
+}
+
+/**
+ *
+ * @async
+ * @param {object} param0
+ * @param {string} param0.meetingId
+ * @param {string} param0.userId
+ * @param {string} param0.meetingToken
+ * @returns - http result
+ */
+
+export async function deleteShare({meetingId, userId, meetingToken}) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+		"x-jibb-meeting-jwt": meetingToken,
+	}
+	return http.delete(`${Config.apiBaseURL}/v1/meetings/${meetingId}/shares/${userId}`, headers)
+}
+
+/**
+ *
+ * @async
+ * @returns {array} - list of meeting shared with me.
+ */
+export async function getListShareMe() {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/meetings/shares`, headers)
+
+	return response.data.shares
+}
+
+/**
+ *
+ * @param {string} meetingId
+ * @returns - http result.
+ */
+export async function deleteShareMe(meetingId) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken(),
+	}
+	return http.delete(`${Config.apiBaseURL}/v1/meetings/shares/${meetingId}`, headers)
+}
+
+
+