nayota-show-sdk 0.0.1 → 0.0.3

package/api/alarmProgress.js

@@ -0,0 +1,147 @@
+/**
+ * @file 报警进度接口
+ * @module 报警进度接口
+ * @memberof requestShow
+ */
+import { requestShow } from '../utils'
+
+/**
+ * @typedef {Object} alarmProgress - 报警进度对象
+ * @property {string} alarmRecord - 报警记录id
+ * @property {number} processingState - 告警进度的处理状态 1待处理、2处理中、3已处理、4云呼通知中、5短信通知、6缺岗、7已通知、8真实报警、9测试、10误报、13云呼通知失败、14推送给第三方、15处理完成、16人工处理、17设备自动复位、18短信发送失败、19跟进中。
+ * @property {number} event_time - 告警进度的处理时间 毫秒时间戳。
+ * @property {string} desc - 告警进度的描述。
+*/
+
+
+/**
+ * 获取告警进度列表
+ * @param {Object} query 请求对象
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @param {string} query.label - 模糊查询关键字
+ * @param {string} query.search - 模糊查询内容
+ * @param {string} query.alarmRecord - 关联到AlarmRecord的引用。
+ * @example <caption>请求范例</caption>
+ * {
+ *  page: 1,
+ *  limit: 10, 
+ *  label: 'desc', 
+ *  search: '报警',
+ *  alarmRecord: ''
+ * }
+ * @example <caption>返回范例</caption>
+ * {
+ *   "code": 0,
+ *   "total": 1,
+ *   "rows": [
+ *     {
+ *       "_id": "5f7d9d5d5d1d8a00177d5d1d",
+ *       "alarmRecord": "5f7d9d5d5d1d8a00177d5d1c",
+ *       "processingState": 1,
+ *       "event_time": 1606902400000,
+ *       "desc": "报警描述",
+ *       "creator": "5f7d9d5d5d1d8a00177d5d1b",
+ *     }
+ *   ]
+ * }
+ * @returns {Object} - 包含报警进度的对象
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 报警进度总数
+ * @returns {Array} rows - 报警进度数组
+ * @returns {Object} data - 见数据类型alarmProgress定义
+ * @returns {string} data.alarmRecord - 报警记录id
+ * @returns {number} data.processingState - 告警进度处理状态 详见数据类型alarmProgress.processingState定义
+ * @returns {number} data.event_time - 告警进度的处理时间 毫秒时间戳。
+ * @returns {string} data.desc - 告警进度的描述。
+ */
+export function list(query) {
+  return requestShow({
+    url: '/alarm-progress',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增报警进度记录
+ * @param {object} data - 见数据类型alarmProgress定义
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 见数据类型alarmProgress定义
+ */
+export function create(data) {
+  return requestShow({
+    url: '/alarm-progress',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取报警进度详情
+ * @param {string} id - 报警id 
+* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+* @returns {number} code - 返回码，0表示成功。
+* @returns {string} _id - 报警进度id
+* @returns {Object} 见数据类型alarmProgress定义
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/alarm-progress/${id}`,
+    method: 'get'
+  })
+}
+
+
+/**
+ * 编辑报警进度详情
+ * @param {Object} data 修改数据对象
+ * @param {string} data._id - 报警进度id
+ * @param {Object} data.other 见数据类型alarmProgress定义
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 报警进度对象 字段见list返回字段
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/alarm-progress/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除进度
+ * @param {string} id - 报警id 
+* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} 见数据类型alarmProgress定义
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/alarm-progress/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除报警进度
+ * @param {Array} ids - 报警进度ids 
+* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+* @returns {number} code - 返回码，0表示成功。
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/alarm-progress',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  getOne,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}

package/api/alarmRecord.js

@@ -0,0 +1,312 @@
+/**
+ * @file 报警记录api
+ * @module 报警记录接口
+ * @memberof requestShow
+ */
+import { requestShow } from '../utils'
+
+
+/**
+ * 获取列表
+ * @param {*} query 
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @param {string} query.label - 模糊查询关键字
+ * @param {string} query.search - 模糊查询内容
+ * @returns {Object} - 包含报警记录的对象
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 报警记录总数
+ * @returns {Array} rows - 报警记录数组
+ * @returns {number} mainType - 告警的主要类型（1：设备告警，2：异常告警，3：设备故障，4：离线告警）。
+ * @returns {string} subType - 告警的子类型。
+ * @returns {mongoose.Schema.Types.ObjectId} device - 关联的设备。
+ * @returns {number} event_time - 告警发生的时间（毫秒时间戳）。
+ * @returns {string} desc - 告警的描述。
+ * @returns {number} number - 告警发生的次数。
+ * @returns {number} processingState - 告警的处理状态（1：待处理，2：处理中，3：已处理）。
+ * @returns {number} processingResult - 处理结果（9：云呼通知失败，10：缺岗，12：短信发送失败，13：跟进中，1：已通知，11：云呼通知中，2：真实告警，3：测试，4：误报，5：处理完成，6：人工处理，7：设备自动复位，8：已推送至第三方）。
+ * @returns {number} noticeWay - 通知方式（1：云呼，2：短信，3：人工通知）。
+ * @returns {string} fireDesc - 火灾事件的描述。
+ * @returns {number} lastSmsTime - 最后发送短信的时间 毫秒时间戳。
+ * @returns {number} lastCallTime - 最后发送云呼的时间 毫秒时间戳。
+ * @returns {string} confirmPersonName - 处理告警的人员姓名。
+ * @returns {number} disposalDuration - 处置时长 毫秒时间戳。
+ * @returns {number} processingTime - 已处理的时间 毫秒时间戳。
+ * @returns {Array} picUrls - 告警图片的URL。
+ * @returns {Schema.Types.ObjectId} wxUser - 关联的微信用户。
+ * @returns {Schema.Types.ObjectId} creator - 关联的用户。
+ * @returns {Date} createdAt - 告警记录的创建日期。
+ * @returns {Date} updatedAt - 告警记录的最后更新日期。
+ */
+export function list(query) {
+  return requestShow({
+    url: '/alarm-records',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增报警记录
+ * @param {Object} data - 包含报警记录的请求体 属性见list返回字段。
+ */
+export function create(data) {
+  return requestShow({
+    url: '/alarm-records',
+    method: 'post',
+    data
+  })
+}
+
+/**
+  * 根据提供的参数检索报警计数。
+  *
+  * @param {Object} data - 包含参数的请求体。
+  * @param {string} data.mainType - 报警的主要类型 。
+  * @param {Date} data.startTime - 用于过滤报警的开始时间 毫秒时间戳（可选）。
+  * @param {Date} data.endTime - 用于过滤报警的结束时间 毫秒时间戳（可选）。
+  * @param {Date} data.startMonth - 用于过滤报警的开始月份 毫秒时间戳（可选）。
+  * @param {Date} data.endMonth - 用于过滤报警的结束月份 毫秒时间戳（可选）。
+  * @returns {Object} - 包含报警计数的结果对象。
+  * @returns {number} result.total - 报警的总数。
+  * @returns {number} result.todayTotal - 今天发生的报警数量。
+  * @returns {number} result.monthTotal - 当前月份发生的报警数量。
+  * @returns {number} result.processed - 已处理的报警数量。
+  * @returns {number} result.waitProcess - 等待处理的报警数量。
+  * @returns {number} result.processing - 正在处理的报警数量。
+  * @returns {number} code - 状态码（0表示成功）。
+  */
+export function getAlarmCount(data) {
+  return requestShow({
+    url: '/alarm-records/alarm-count',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取报警未处理和处理中的总数
+ * @param {Object} data - 请求体参数 目前不用传此参数
+ * @returns {Object} - 包含报警总数的对象
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 报警总数对象
+ * @returns {number} data.total - 报警总数
+ * @returns {number} data.deviceCount - 设备报警总数
+ * @returns {number} data.errorCount - 设备异常总数
+ * @returns {number} data.troubleCount - 设备故障总数
+ * @returns {number} data.offlineCount - 设备离线总数
+ */
+export function getAlarmTotalCount(data) {
+  return requestShow({
+    url: '/alarm-records/alarm-total-count',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 人员测试云呼
+ * @param {*} data 目前不用传此参数
+ * @returns {Object} - 包含报警总数的对象
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} message - 错误描述
+ */
+export function cloudCall(data) {
+  return requestShow({
+    url: '/alarm-records/cloud-call',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 报警云呼 用于报警页面通知人员
+ * @param {*} data 目前不用传此参数
+ * @returns {Object} - 返回对象
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function alarmCloudCall(data) {
+  return requestShow({
+    url: '/alarm-records/alarm-cloud-call',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 批量处理
+ * @param {Object} data 处理参数对象
+ * @param {boolean} data.isAll - 是否全部处理
+ * @param {Object} data.query - 查询参数对象 当isAll为true时，query必传
+ * @param {number} data.query.mainType - 查询告警的主要类型（1：设备告警，2：异常告警，3：设备故障，4：离线告警）
+ * @param {Array} data.query.range - 查询的时间范围[开始毫秒时间戳，结束毫秒时间戳]
+ * @param {number} data.query.processingState - 查询的告警的处理状态（1：待处理，2：处理中，3：已处理）
+ * @param {Array} data.alarmRecords - 待处理的报警记录id数组
+ * @param {number} data.processingResult - 处理结果（9：云呼通知失败，10：缺岗，12：短信发送失败，1：已通知，11：云呼通知中，2：真实告警，3：测试，4：误报，5：处理完成，6：人工处理，7：设备自动复位，8：已推送至第三方）
+ * @param {string} data.fireDesc - 报警描述
+ * @returns {Object} - 返回对象
+ * @returns {number} code - 返回码，0表示成功
+ * @example <caption>请求范例</caption>
+ * 当isAll为true时，传以下参数。代表处理条件内的所有报警记录
+ * {
+ *  isAll: true,
+ *  query: {
+ *    mainType: 1,
+ *    range: [1727078400000, 1727164800000],
+ *    processingState: 1
+ *  },
+ *  processingResult: 2,
+ *  fireDesc: '报警描述'
+ * }
+ * 当isAll为false时，传以下参数
+ * {
+ *  alarmRecords: ['5f7d9d5d5d1d8a00177d5d1c', '5f7d9d5d5d1d8a00177d5d1d'],
+ *  mainType: 1,
+ *  processingResult: 2,
+ *  fireDesc: '报警描述'
+ * }
+ */
+export function processingManyAlarm(data) {
+  return requestShow({
+    url: '/alarm-records/processing-many-alarm',
+    method: 'post',
+    data
+  })
+}
+
+/**
+   * 微信小程序上传故障记录。
+   *
+   * @param {Object} data - 包含故障记录所需数据的请求体。
+   * @param {string} data.device - 与故障记录关联的设备的ID。
+   * @param {string} data.wxUser - 与故障记录关联的用户的ID。
+   * @param {string} data.subType - 故障记录的子类型。
+   * @param {string} data.desc - 故障记录的描述。
+   * @param {string[]} data.picUrls - 与故障记录关联的图片的URL。
+   * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+   * @returns {number} code - 返回码，0表示成功。
+   */
+// export function uploadTroubleAlarm(data) {
+//   return requestShow({
+//     url: '/alarm-records/upload-trouble-alarm',
+//     method: 'post',
+//     data
+//   })
+// }
+
+/**
+   * 报警记录导出excel。
+   *
+   * @param {Object} data - 包含故障记录所需数据的请求体。
+   * @param {string} data.startTime - 开始时间戳。
+   * @param {string} data.endTime - 结束时间戳。
+   * @param {string} data.xxx -  其他条件根据字段可自定义筛选 如mainType: 1
+   * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+   * @returns {number} code - 返回码，0表示成功。
+   * @returns {string} data - excel文件的下载相对链接。
+   * @returns {string} message - 描述。
+   */
+export function exportAlarmRecord(data) {
+  return requestShow({
+    url: '/alarm-records/export-alarm-excel',
+    method: 'post',
+    data
+  })
+}
+
+
+/**
+ * 获取报警详情
+ * @param {string} 报警id 
+* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 报警记录对象 字段见list返回字段
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/alarm-records/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 编辑报警详情
+ * @param {Object} data 修改数据对象
+ * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+  * @returns {number} code - 返回码，0表示成功。
+  * @returns {Object} data - 报警记录对象 字段见list返回字段
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/alarm-records/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除报警
+ * @param {string} 报警id 
+* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 报警记录对象 字段见list返回字段
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/alarm-records/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除报警
+ * @param {Array} 报警ids 
+* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+* @returns {number} code - 返回码，0表示成功。
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/alarm-records',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+/**
+   * 获取多天报警计数
+   * @param {Object} data - 请求体参数
+   * @param {Array} data.timestamps - 时间戳数组
+   * @param {number} data.timestamps[].startTime - 开始时间戳
+   * @param {number} data.timestamps[].endTime - 结束时间戳
+   * @returns {Object} - 包含报警计数的对象
+   * @returns {number} code - 返回码，0表示成功
+   * @returns {Array} data - 报警计数数组
+   * @returns {string} data[].date - 格式化后的时间字符串
+   * @returns {Array} data[].counts - 报警类型计数数组
+   * @returns {string} data[].counts[].type - 报警类型
+   * @returns {number} data[].counts[].count - 报警计数
+   */
+export function getMoreAlarmCount(data) {
+  return requestShow({
+    url: '/alarm-records/more-alarm-count',
+    method: 'post',
+    data
+  })
+}
+
+export default {
+  list,
+  getOne,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany,
+  getAlarmCount,
+  getAlarmTotalCount,
+  getMoreAlarmCount,
+  cloudCall,
+  alarmCloudCall,
+  processingManyAlarm,
+  // uploadTroubleAlarm,
+  exportAlarmRecord
+}

package/api/departs.js

@@ -0,0 +1,91 @@
+import { requestShow } from '../utils'
+/**
+ * @file 层级api
+ * @module 层级接口
+ */
+/**
+ * 
+ * @param {*} query
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @param {string} query.depart - 层级id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 层级总数
+ * @returns {Array} rows - 层级数组
+ * @returns {string} rows._id - 层级id
+ * @returns {string} rows.name - 层级名称
+ * @returns {string} rows.father - 父级层级id
+ * @returns {array} rows.fathers - 所有的上级层级id
+ * @returns {number} rows.level - 层级级别
+ * @returns {boolean} rows.status - 层级启用状态
+ * @returns {string} rows.sort - 排序字段
+ */
+export function list(query) {
+  return request({
+    url: '/departs',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增层级
+ * @param {Object} data - 包含层级的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
+ */
+export function create(data) {
+  return requestShow({
+    url: '/departs',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 修改层级
+ * @param {Object} data - 包含层级的请求体 属性见list返回字段。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/departs/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除层级
+ * @param {string} id - 删除的层级id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/departs/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除层级
+ * @param {Array} ids - 删除的层级ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/departs',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}
+

package/api/product.js

@@ -0,0 +1,19 @@
+/**
+ * @file 产品管理api
+ * @module 产品管理接口
+ * @memberof requestShow
+ */
+import { requestShow as request } from '../utils'
+
+// 创建多平台设备
+function createAllDevice(data) {
+  return request({
+    url: `/product/${data._id}/createAllDevice`,
+    method: 'post',
+    data
+  })
+}
+
+export default {
+  createAllDevice
+}

package/index.js

@@ -1,9 +1,11 @@
 import config from './config/urlcfg'
 import { init } from './utils'
 import emitter from './utils/EventEmitter'
-
+import alarmRecord from './api/alarmRecord'
+import alarmProgress from './api/alarmProgress'
 const api = {
-
+  alarmRecord,
+  alarmProgress
 }
 
 export default { config: options => {

package/jsdoc.json

@@ -17,7 +17,7 @@
         ]
     },
     "templates": {
-        "systemName": "nayota-datav-sdk",
+        "systemName": "nayota-show-sdk",
         "footer": "宁波边缘物联有限公司",
         "copyright": "宁波边缘物联有限公司",
         "navType": "vertical",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nayota-show-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "nayota-show-server rest-api",
   "type": "module",
   "main": "index.js",
@@ -24,4 +24,4 @@
     "jsdom": "^24.0.0",
     "taffydb": "^2.7.3"
   }
-}
+}

package/utils/index.js

@@ -1,9 +1,9 @@
 import httpConfig from './http-config'
-let request = httpConfig()
+let requestShow = httpConfig()
 const init = () => {
-  request = httpConfig()
+  requestShow = httpConfig()
 }
 export {
   init,
-  request
+  requestShow
 }