@jibb-open/jssdk 3.5.5

package/.babelrc

@@ -0,0 +1,31 @@
+{
+  "env": {
+    "webapp": {
+			"ignore": ["**/*.xapi.js", "**/*.webex-devices.js"],
+			"presets": [
+				[
+					"@babel/env",
+					{
+						"targets": {
+							"edge": "17",
+							"firefox": "60",
+							"chrome": "67",
+							"safari": "11.1"
+						},
+						"useBuiltIns": "usage",
+						"corejs": "3.6.5"
+					}
+				]
+			],
+
+			"plugins": [
+				[
+					"babel-plugin-transform-import-ignore",
+					{
+						"patterns": [".webex-devices.js", "*xapi*"]
+					}
+				]
+			]
+		}
+  }
+}

package/README.md

@@ -0,0 +1,3 @@
+# jibb-jssdk
+
+please see code examples under Namespaces > Examples

package/package.json

@@ -0,0 +1,72 @@
+{
+	"name": "@jibb-open/jssdk",
+	"version": "3.5.5",
+	"description": "",
+	"scripts": {
+		"test": "LOG_LEVEL=error mocha --timeout 10000 ",
+		"coverage": "npm run test",
+		"build": "BABEL_ENV=webapp babel src --out-dir dist --copy-files --no-copy-ignored",
+		"watch": "watch 'npm run build' src",
+		"docs": "jsdoc -r ./src/ ./README.md"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/Inkerz/jibb-jssdk.git"
+	},
+	"author": "",
+	"license": "ISC",
+	"bugs": {
+		"url": "https://github.com/Inkerz/jibb-jssdk/issues"
+	},
+	"homepage": "https://github.com/Inkerz/jibb-jssdk#readme",
+	"dependencies": {
+		"axios": "^0.24.0",
+		"browser-or-node": "^2.0.0",
+		"buffer": "^6.0.3",
+		"bufferutil": "^4.0.6",
+		"core-js": "^3.23.1",
+		"dateformat": "^5.0.3",
+		"isomorphic-ws": "^4.0.1",
+		"jwt-decode": "^3.1.2",
+		"path": "^0.12.7",
+		"pino": "^7.6.5",
+		"pino-pretty": "^7.5.3",
+		"protobufjs": "6.11.3",
+		"rimraf": "^3.0.2",
+		"utf-8-validate": "^5.0.9",
+		"ws": "^8.5.0"
+	},
+	"devDependencies": {
+		"@babel/cli": "^7.17.10",
+		"@babel/core": "^7.19.6",
+		"@babel/node": "^7.20.0",
+		"@babel/plugin-transform-modules-commonjs": "^7.19.6",
+		"@babel/plugin-transform-runtime": "^7.18.5",
+		"@babel/polyfill": "^7.12.1",
+		"@babel/preset-env": "^7.19.4",
+		"@babel/runtime": "^7.20.0",
+		"babel-loader": "^8.2.5",
+		"babel-plugin-add-module-exports": "^1.0.4",
+		"babel-plugin-transform-import-ignore": "^1.1.0",
+		"babel-plugin-transform-inline-environment-variables": "^0.4.4",
+		"chai": "^4.3.6",
+		"chai-http": "^4.3.0",
+		"chai-spies": "^1.0.0",
+		"copy-webpack-plugin": "^10.2.4",
+		"core-js": "^3.23.1",
+		"dotenv": "^16.0.0",
+		"esm": "^3.2.25",
+		"file-loader": "^6.2.0",
+		"gzip-loader": "^0.0.1",
+		"jsdoc": "^4.0.0",
+		"mocha": "^9.2.0",
+		"null-loader": "^4.0.1",
+		"nyc": "^15.1.0",
+		"pako": "^2.0.4",
+		"raw-loader": "^4.0.2",
+		"watch": "^1.0.2",
+		"webpack": "^5.74.0",
+		"webpack-bundle-analyzer": "^4.6.1",
+		"webpack-cli": "^4.9.2"
+	}
+}

package/src/api/admin.js

@@ -0,0 +1,333 @@
+import {Config} from '../config.js';
+import {http} from "../utils/http/index.js"
+import {Auth} from "./auth.js"
+import {AccessLevel, UserType} from "../types/types.js"
+
+
+/**
+ * 
+ * @module admin
+ * This is an experimental API.
+ */
+
+const accessLevel = AccessLevel.ADMIN
+
+
+/**
+ *
+ * 
+ * @async
+ * @returns {array} - list of Organization
+ */
+export async function getOrganizationList() {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/admin/organizations`, headers)
+	return response.data.organizations
+}
+
+/**
+ * 
+ * @async
+ * @param {number} orgId 
+ * @returns {object}
+ */
+export async function getOrganizationDetails(orgId) {
+	if (orgId === "") {
+		throw new Error("organization ID can not be empty")
+	}
+
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}`, headers)
+	return response.data
+}
+
+/**
+ * 
+ * @async
+ * @param {number} orgId 
+ * @param {*} pagination 
+ * @returns {list}
+ */
+export async function getUserList(orgId, pagination) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	if (pagination !== undefined) headers["x-jibb-pagination"] = JSON.stringify(pagination)
+	let response = await http.get(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/users`, headers)
+
+	pagination = response.headers["x-jibb-pagination"]
+	pagination = pagination && JSON.parse(pagination)
+	return {
+		users: response.data.users,
+		pagination: pagination,
+	}
+}
+
+/**
+ * 
+ * @async
+ * @param {object} param0  
+ * @param {Number} param0.orgId
+ * @param {list} param0.users - list of user object that contain email, first_name, last_name, user_type. user_type is a number from 0-4 
+ * @returns - http result
+ */
+export async function createUsers({ orgId, users }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let body = {
+		users,
+	}
+	return http.post(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/users`, body, headers)
+}
+
+
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {string} param0.orgId 
+ * @param {string} param0.email 
+ * @param {number} param0.userType - UNKNOWN = 0; LIMITED = 1; MEMBER = 2; ADMIN = 3; OWNER = 4;
+ * @returns  - http result
+ */
+export async function createOrganizationUser({ orgId, email, userType }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let body = {
+		users: [
+			{
+				email: email,
+				user_type: userType,
+			},
+		],
+	}
+	return http.post(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/users`, body, headers)
+}
+
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {number} param0.orgId 
+ * @param {number} param0.userId 
+ * @returns - http result
+ */
+export async function SendUserActivationEmail({ orgId, userIds }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let body = {
+		user_ids: userIds,
+	}
+	return http.post(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/activation/email`, body, headers)
+}
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {number} param0.orgId 
+ * @param {number} param0.userId 
+ * @returns - http result
+ */
+export async function deleteOrganizationUser({ orgId, userId }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	return http.delete(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/users/${userId}`, headers)
+}
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {number} param0.orgId 
+ * @param {number} param0.userId 
+ * @param {number} param0.userType - UNKNOWN = 0; LIMITED = 1; MEMBER = 2; ADMIN = 3; OWNER = 4;
+ * @returns - http result
+ */
+export async function updateUserType({ orgId, userId, userType }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let body = {
+		user_type: userType,
+	}
+	return http.patch(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/users/${userId}`, body, headers)
+}
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {number} param0.orgId 
+ * @param {number} param0.userId 
+ * @returns {object}
+ */
+export async function getOrganizationUserDetails({ orgId, userId }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/users/${userId}`, headers)
+	return response.data
+}
+
+//  error code:401 status:Unauthorized   should we / what token to use ?  , orgId? not sure of the body
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {number} param0.orgId 
+ * @param {string} [param0.metadata=] 
+ * @param {boolean} [param0.autoAddUsers=false] 
+ * @param {UserType} [param0.defaultUserType=0]  - UNKNOWN = 0; LIMITED = 1; MEMBER = 2; ADMIN = 3; OWNER = 4;
+ * @param {boolean} [param0.enabled=fales] 
+ * @returns - http result
+ */
+export async function setSAML({ orgId, metadata, autoAddUsers, defaultUserType, enabled }) {
+	if (orgId === "" || orgId === undefined) {
+		throw new Error("organization ID can not be empty")
+	}
+
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let body = {
+		organization_id: orgId,
+		metadata: metadata || "",
+		auto_add_users: autoAddUsers !== undefined ? autoAddUsers : false,
+		default_user_type: defaultUserType !== undefined ? defaultUserType : UserType.UNKNOWN,
+		enabled: enabled || false,
+	}
+
+	return http.put(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/saml`, body, headers)
+}
+
+//  error code:401 status:Unauthorized   should we / what token to use ?  , orgId? not sure of the body
+/**
+ * @async
+ * @param {number} orgId 
+ * @returns - http result
+ */
+export async function deleteSAML(orgId) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	return http.delete(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/saml`, headers)
+}
+/**
+ * 
+ * @async
+ * @param {number} orgId 
+ * @returns {object}
+ */
+export async function getSAML(orgId) {
+	if (orgId === "") {
+		throw new Error("organization ID can not be empty")
+	}
+
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/saml`, headers)
+	return response.data
+}
+/**
+ * 
+ * @async
+ * @param {number} orgId 
+ * @returns {object}
+ */
+export async function getDomainList(orgId) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let response = await http.get(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/domains`, headers)
+	return response.data
+}
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {object} param0.orgId 
+ * @param {string} param0.domain 
+ * @returns {object}
+ */
+export async function createDomain({ orgId, domain }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let body = {
+		domain_name: domain,
+	}
+	let response = await http.post(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/domains`, body, headers)
+	return response.data
+}
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {object} param0.orgId 
+ * @param {string} param0.domain 
+ * @returns - http result
+ */
+export async function deleteDomain({ orgId, domainId }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	return http.delete(`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/domains/${domainId}`, headers)
+}
+/**
+ * 
+ * @async
+ * @param {object} param0 
+ * @param {object} param0.orgId 
+ * @param {string} param0.domain 
+ * @returns {object}
+ */
+export async function verifyDomain({ orgId, domainId }) {
+	let headers = {
+		"Content-Type": "application/json",
+		Accept: "application/json",
+		"x-jibb-user-jwt": await Auth.getUserToken({ accessLevel: accessLevel }),
+	}
+	let response = await http.get(
+		`${Config.apiBaseURL}/v1/admin/organizations/${orgId}/domains/${domainId}/verify`,
+		headers
+	)
+	return response.data
+}
+

package/src/api/auth.js

@@ -0,0 +1,208 @@
+import { Config } from "../config.js"
+import { logger } from "../utils/logger/index.js"
+import { AccessLevel, UserClaims } from "../types/types.js"
+import { http } from "../utils/http/index.js"
+
+/**
+ * @module auth
+ */
+
+
+/**
+ * AuthClass.
+ * @class AuthClass
+ *
+ */
+
+class AuthClass {
+	#userClaims
+
+	constructor() {
+		logger.debug("Creating new Auth instance")
+		this.apiKey = undefined
+		this.#userClaims = new Map()
+		this.getIdToken = undefined
+	}
+
+	/**
+	 * Manually setting userToken
+	 * @param {string} token
+	 * @param {AccessLevel} accessLevel
+	 */
+	setUserToken(token, accessLevel = AccessLevel.USER) {
+		let claims = new UserClaims(token)
+		this.#userClaims.set(accessLevel, claims)
+	}
+
+	/**
+	 * setting Api key
+	 * @param {string} apiKey
+	 */
+	setApiKey(apiKey) {
+		this.apiKey = apiKey
+		this.#userClaims.clear()
+	}
+
+	async #getUserTokenFromApiKey({ expiry, accessLevel }) {
+		let headers = {
+			"Content-Type": "application/json",
+			Accept: "application/json",
+		}
+		let body = {
+			api_key: this.apiKey,
+			expiry: {
+				seconds: expiry,
+			},
+		}
+		let url
+
+		switch (accessLevel) {
+			case AccessLevel.ADMIN:
+				url = `${Config.apiBaseURL}/v1/admin/auth/token`
+				break
+			case AccessLevel.SUPERADMIN:
+				url = `${Config.apiBaseURL}/v1/superadmin/auth/token`
+				break
+			default:
+				url = `${Config.apiBaseURL}/v1/auth/token`
+				break
+		}
+
+		let response = await http.post(url, body, headers)
+		return response.data.token
+	}
+
+	async #getUserTokenFromIDToken({ expiry, accessLevel }) {
+		let headers = {
+			"Content-Type": "application/json",
+			Accept: "application/json",
+			"x-jibb-id-jwt": await this.getIdToken(),
+		}
+		let body = {
+			expiry: {
+				seconds: expiry,
+			},
+		}
+		let url
+
+		switch (accessLevel) {
+			case AccessLevel.ADMIN:
+				url = `${Config.apiBaseURL}/v1/admin/auth/token`
+				break
+			case AccessLevel.SUPERADMIN:
+				url = `${Config.apiBaseURL}/v1/superadmin/auth/token`
+				break
+			default:
+				url = `${Config.apiBaseURL}/v1/auth/token`
+				break
+		}
+
+		let response = await http.post(url, body, headers)
+		return response.data.token
+	}
+
+	/**
+	 *
+	 * @returns {UserClaims}
+	 */
+	async getUserClaims() {
+		await this.getUserToken()
+		return this.#userClaims.get(AccessLevel.USER)
+	}
+
+	/**
+	 *
+	 * @async
+	 * @param {object} [param0={}]
+	 * @param {Number} [param0.expiry=3600] - meeting ID.
+	 * @param {boolean} [param0.refresh=fales] - 1 Read or 2 Write.
+	 * @param {AccessLevel} [param0.accessLevel=AccessLevel.USER]
+	 * @returns {string} - user Token.
+	 */
+
+	async getUserToken({ expiry, refresh, accessLevel } = {}) {
+		let claim = undefined
+		refresh = refresh || false
+		accessLevel = accessLevel || AccessLevel.USER
+		expiry = expiry || 3600
+
+		if (refresh === true) {
+			await this.#refreshUserToken({ expiry, accessLevel })
+		}
+
+		claim = this.#userClaims.get(accessLevel)
+		if (claim !== undefined && !claim.isExpired()) return claim.token
+
+		await this.#refreshUserToken({ expiry, accessLevel })
+
+		claim = this.#userClaims.get(accessLevel)
+		if (claim !== undefined && !claim.isExpired()) return claim.token
+
+		throw new Error("could not create user token")
+	}
+
+	async #refreshUserToken({ expiry, accessLevel }) {
+		if (this.apiKey) {
+			let token = await this.#getUserTokenFromApiKey({ expiry, accessLevel })
+			this.setUserToken(token, accessLevel)
+			return token
+		}
+
+		try {
+			let token = await this.#getUserTokenFromIDToken({ expiry, accessLevel })
+			this.setUserToken(token, accessLevel)
+			return token
+		} catch (error) {
+			logger.error(error)
+		}
+	}
+
+	/**
+	 * clear user.
+	 */
+
+	logout() {
+		this.#userClaims.clear()
+	}
+
+	/**
+	 *
+	 * Generate a new API Key, old API KEY will be discareded
+	 * It require a userToken to be set.
+	 * @returns {string} api key
+	 */
+	async generateAPIKey() {
+		let headers = {
+			"Content-Type": "application/json",
+			Accept: "application/json",
+			"x-jibb-user-jwt": await this.getUserToken(),
+		}
+		let response = await http.get(`${Config.apiBaseURL}/v1/auth/apikey`, headers)
+		return response.data.apiKey
+	}
+
+	/**
+	 *
+	 * Generating a one time password.
+	 * It require a IdToken to be set.
+	 * @async
+	 * @returns  {string} - Custom Password.
+	 */
+	async generateCustomAuthPassword() {
+		let headers = {
+			"Content-Type": "application/json",
+			Accept: "application/json",
+			"x-jibb-id-jwt": await this.getIdToken(),
+		}
+
+		let response = await http.get(`${Config.apiBaseURL}/v1/auth/custom`, headers)
+		return response.data.password
+	}
+}
+
+/**
+ *   Expotred instance of AuthClass.
+ * @type {AuthClass}
+ */
+let Auth = new AuthClass()
+export { Auth }