nayota-show-sdk 0.0.8 → 0.1.0

package/api/bmsRole.js

@@ -0,0 +1,107 @@
+import { requestShow } from '../utils'
+/**
+ * @file BMS角色api
+ * @module BMS角色接口
+ */
+
+
+/**
+ * 角色类型枚举
+ * @readonly
+ * @enum {number}
+ */
+var userType = {
+  主角色: 0,
+  副角色: 1
+}
+/**
+ * 
+ * @param {*} query
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 角色总数
+ * @returns {Array} rows - 角色数组
+ * @returns {string} rows._id - 角色id
+ * @returns {string} rows.name - 角色名称必须唯一
+ * @returns {number} rows.sort - 排序序号
+ * @returns {string} rows.desc - 角色描述
+ * @returns {Object} rows.users - 关联的用户列表
+ * @returns {number} rows.type - 角色通用类型默认为-0
+ * @returns {number} rows.userType - 查看枚举userType
+ * @returns {Array} rows.userIds - 关联的用户id列表
+ * @returns {boolean} rows.control - 是否可控制默认为true
+ * @returns {Array} rows.routers - 拥有的权限列表
+ * @returns {string} rows.routers.subject - 权限主题
+ * @returns {Array} rows.routers.actions - 权限列表
+ * @returns {Array} rows.routers.children - 路由列表
+ */
+export function list(query) {
+  return requestShow({
+    url: '/bms-roles',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增路由
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
+ */
+export function create(data) {
+  return requestShow({
+    url: '/bms-roles',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 修改路由
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/bms-roles/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除路由
+ * @param {string} id - 删除的路由id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/bms-roles/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除路由
+ * @param {Array} ids - 删除的路由ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/bms-roles',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}
+

package/api/bmsRouter.js

@@ -0,0 +1,119 @@
+import { requestShow } from '../utils'
+/**
+ * @file BMS路由api
+ * @module BMS路由接口
+ */
+
+
+/**
+ * 路由method枚举
+ * @readonly
+ * @enum {string}
+ */
+var method = {
+  all: 'all',
+  get: 'get',
+  post: 'post',
+  put: 'put',
+  delete: 'delete'
+}
+/**
+ * 
+ * @param {*} query
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 路由总数
+ * @returns {Array} rows - 路由数组
+ * @returns {string} rows._id - 路由id
+ * @returns {string} rows.type - 路由类型
+ * @returns {string} rows.name - 路由名称
+ * @returns {string} rows.path - 路由路径
+ * @returns {number} rows.level - 路由等级
+ * @returns {number} rows.sort - 排序序号
+ * @returns {Array} rows.children - 子路由列表
+ * @returns {string} rows.method - 查看枚举method
+ * @returns {string} rows.desc - 路由描述
+ * @returns {Array} rows.roles - 关联的角色列表
+ * @returns {Array} rows.actions - 关联的功能列表
+ * @returns {string} rows.actions.name - 功能名称
+ * @returns {string} rows.actions.code - 功能编码
+ * @returns {string} rows.subject - 主题
+ * @returns {Array} rows.deviceClass - 关联的设备类型
+ * @returns {string} rows.deviceClass.name - 设备类型名称
+ * @returns {string} rows.deviceClass.icon - 设备类型图标
+ * @returns {string} rows.deviceClass.code - 设备类型编码
+ * @returns {string} rows.deviceClass.departTag - 设备类型层级标签
+ * @returns {Object} rows.deviceClass.uis - 设备类型ui信息
+ * @returns {string} rows.customJson - 自定义json
+ * @returns {string} rows.icon - 图标
+ */
+export function list(query) {
+  return requestShow({
+    url: '/bms-routers',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增路由
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
+ */
+export function create(data) {
+  return requestShow({
+    url: '/bms-routers',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 修改路由
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/bms-routers/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除路由
+ * @param {string} id - 删除的路由id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/bms-routers/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除路由
+ * @param {Array} ids - 删除的路由ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/bms-routers',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}
+

package/api/devices.js

@@ -0,0 +1,156 @@
+import { requestShow } from '../utils'
+/**
+ * @file 设备api
+ * @module 设备接口
+ */
+
+
+/**
+ * 节点数据维度dataDimension
+ * @readonly
+ * @enum {string}
+ */
+var dataDimension = {
+  day: 'day',
+  year: 'year'
+}
+
+/**
+ * 节点类型propType
+ * @readonly
+ * @enum {string}
+ */
+var propType = {
+  check: 'check',
+  operate: 'operate'
+}
+
+/**
+ * 设备状态deviceStatus
+ * @readonly
+ * @enum {number}
+ */
+var deviceStatus = {
+  正常: 0,
+  告警: 1,
+  异常: 2,
+  故障: 3,
+  离线: 4
+}
+
+/**
+ * @typedef {Object} device
+ * @property {string} _id - 设备id
+ * @property {string} name - 设备名称.
+ * @property {Array} hash - 根据参数PropId生成，用于判定设备是否已经导入（新版弃用）
+ * @property {Array} latLng - 设备在平面图上的经纬度
+ * @property {Array} mapLatLng - 设备在地图上的经纬度
+ * @property {string} shortAddress - 设备短地址
+ * @property {Array} attribute - 设备属性
+ * @property {string} attribute.key - 设备属性key
+ * @property {string} attribute.value - 设备属性value
+ * @property {string} attribute.note - 设备属性备注
+ * @property {Array} props - 设备节点
+ * @property {string} props._id - 节点id
+ * @property {string} props.name - 节点名称
+ * @property {string} props.key - 节点key
+ * @property {string} props.dataDimension - 节点数据维度，默认为day天，查看枚举dataDimension
+ * @property {string} props.type - 节点类型，查看枚举propType
+ * @property {string} props.propId - 节点propId，同IOT的check或者operate的_id
+ * @property {number} props.value - 节点最后值
+ * @property {string} props.valueStr - 节点最后值字符串
+ * @property {boolean} props.lineType - 节点在离线判定是否开启
+ * @property {string} props.lineTime - 节点在离线判定时间（单位小时）
+ * @property {boolean} props.statusType - 节点是否开启异常值判定
+ * @property {string} props.interval - 节点异常值判定的区间
+ * @property {string} props.company - 节点单位
+ * @property {array} props.enum - 节点枚举同IOT的区间
+ * @property {string} props.enum.label - 枚举字符串值
+ * @property {number} props.enum.value - 枚举值
+ * @property {number} props.enum.min - 枚举最小值
+ * @property {number} props.enum.max - 枚举最大值
+ * @property {string} n_device - 设备关联IOT展示设备的_id
+ * @property {string} depart - 设备层级id
+ * @property {number} order - 设备排序
+ * @property {string} deviceClass - 设备所属的设备类型
+ * @property {string} deviceStatus - 设备状态查看枚举deviceStatus
+ */
+
+/**
+ * 
+ * @param {*} query
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 设备总数
+ * @returns {Array} rows - 设备数组查看设备数据定义
+ */
+export function list(query) {
+  return request({
+    url: '/devices',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增设备
+ * @param {Object} data - 包含设备的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
+ */
+export function create(data) {
+  return requestShow({
+    url: '/devices',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 修改设备
+ * @param {Object} data - 包含设备的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/devices/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除设备
+ * @param {string} id - 删除的设备id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/devices/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除设备
+ * @param {Array} ids - 删除的设备ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/devices',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}
+

package/api/router.js

@@ -3,6 +3,7 @@ import { requestShow } from '../utils'
  * @file 路由api
  * @module 路由接口
  */
+
 /**
  * 
  * @param {*} query
@@ -20,7 +21,6 @@ import { requestShow } from '../utils'
  * @returns {('all'|'get'|'post'|'put'|'delete')} rows.method - HTTP请求方法
  * @returns {string} rows.desc - 路由描述
  * @returns {Array<mongoose.Schema.Types.ObjectId>} rows.roles - 关联的角色列表
- * @returns {string} rows.icon - 路由图标
  */
 export function list(query) {
   return request({

package/index.js

@@ -6,12 +6,16 @@ import alarmProgress from './api/alarmProgress'
 import systeminfo from './api/systeminfo'
 import router from './api/router'
 import departs from './api/departs'
+import bmsRole from './api/bmsRole'
+import bmsRouter from './api/bmsRouter'
 const api = {
   alarmRecord,
   alarmProgress,
   systeminfo,
   router,
-  departs
+  departs,
+  bmsRole,
+  bmsRouter
 }
 
 export default { config: options => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nayota-show-sdk",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "nayota-show-server rest-api",
   "type": "module",
   "main": "index.js",