@jibb-open/jssdk 3.5.9 → 3.5.11

package/README.md

@@ -1,4 +1,7 @@
 # jibb-jssdk
-For SDK Documentation please visit: http://inkerz.github.io/jibb-jssdk
 
-also, please see code examples under Namespaces > Examples
+For SDK Documentation please visit: https://inkerz.github.io/jibb-jssdk/
+
+For webex macro example download from: https://github.com/Inkerz/jibb-jssdk/releases
+
+also, please see code examples under Namespaces > Examples in documentation for more information.

package/{dist/examples → examples}/webexDevicesMacros/cameraPresets/jibb.js

@@ -23,11 +23,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * </ul>
  * <h3>Installation</h3>
  * <ul style="list-style: circle;">
- *  <li> downalod/get jibb.js.
- *  <li> Get jibbWebexXapi.js from "www.s3.*******.com" for latest jibb sdk or you could use the file in webexDevice jssdk folder (could be out of date).
+ *  <li> downalod webexMacrosExamples.zip from https://github.com/Inkerz/jibb-jssdk/releases.
  *  <li> Log into your Cisco Room Device as and admin.
  *  <li> Navigate to the Macro Editor.
- *  <li> Import and Save each of the following Macros into the Room System: jibbWebexXapi.js and jibb.js .
+ *  <li> Import and Save each of the following Macros into the Room System: jibbWebexXapi.js found under jssdk folder and jibb.js from desired example.
  *  <li> Edite jibb.js by adding camera postion to sanp to when clicked in line 189, 237, 239 or comment lines.
  *  <li> Edite jibb.js by adding your personal Jibb Api Key to in line 182, to get your Api key visit https://app.jibb.ai/ then navigate to personal settings and click Generate.
  *  <li> Save and activate jibb.js .

package/{dist/examples → examples}/webexDevicesMacros/simplestExample/jibb.js

@@ -22,11 +22,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * </ul>
  * <h3>Installation</h3>
  * <ul style="list-style: circle;">
- *  <li> downalod/get jibb.js.
- *  <li> Get jibbWebexXapi.js from "www.s3.*******.com" for latest jibb sdk or you could use the file in webexDevice jssdk folder (could be out of date).
+ *  <li> downalod webexMacrosExamples.zip from https://github.com/Inkerz/jibb-jssdk/releases.
  *  <li> Log into your Cisco Room Device as and admin.
  *  <li> Navigate to the Macro Editor.
- *  <li> Import and Save each of the following Macros into the Room System: jibbWebexXapi.js and jibb.js .
+ *  <li> Import and Save each of the following Macros into the Room System: jibbWebexXapi.js found under jssdk folder and jibb.js from desired example.
  *  <li> Edite jibb.js by adding camera postion to sanp to when clicked in line 114 or comment line 150 to disable it.
  *  <li> Edite jibb.js by adding your personal Jibb Api Key to in line 143, to get your Api key visit https://app.jibb.ai/ then navigate to personal settings and click Generate.
  *  <li> Save and activate jibb.js .

package/{dist/examples → examples}/webexDevicesMacros/withCameraControl/jibb.js

@@ -23,11 +23,10 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
  * </ul>
  * <h3>Installation</h3>
  * <ul style="list-style: circle;">
- *  <li> downalod/get jibb.js.
- *  <li> Get jibbWebexXapi.js from "www.s3.*******.com" for latest jibb sdk or you could use the file in webexDevice jssdk folder (could be out of date).
+ *  <li> downalod webexMacrosExamples.zip from https://github.com/Inkerz/jibb-jssdk/releases.
  *  <li> Log into your Cisco Room Device as and admin.
  *  <li> Navigate to the Macro Editor.
- *  <li> Import and Save each of the following Macros into the Room System: jibbWebexXapi.js and jibb.js .
+ *  <li> Import and Save each of the following Macros into the Room System: jibbWebexXapi.js found under jssdk folder and jibb.js from desired example.
  *  <li> Edite jibb.js by adding camera postion to sanp to when clicked in line 114 or comment line 153 to disable it.
  *  <li> Edite jibb.js by adding your personal Jibb Api Key to in line 182, to get your Api key visit https://app.jibb.ai/ then navigate to personal settings and click Generate.
  *  <li> Save and activate jibb.js .

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@jibb-open/jssdk",
-	"version": "3.5.9",
+	"version": "3.5.11",
 	"description": "",
 	"scripts": {
 		"test": "LOG_LEVEL=error mocha --timeout 10000 ",

package/.babelrc

@@ -1,31 +0,0 @@
-{
-  "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/dist/package.json

@@ -1,69 +0,0 @@
-{
-	"name": "@jibb-open/jssdk",
-	"version": "3.5.9",
-	"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": "https://github.com/Inkerz/jibb-jssdk",
-	"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

@@ -1,333 +0,0 @@
-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
-}
-