nayota-show-sdk 1.1.2 → 1.1.3

package/api/alarmProgress.js

@@ -1,21 +1,31 @@
 /**
  * @file 报警进度接口
  * @module 报警进度接口
- * @memberof requestShow
+ * @category 报警模块
  */
 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 - 告警进度的描述。
+ * @typedef {Object} alarmProgress - 报警进度
+ * @property {string} alarmRecord - 报警id
+ * @property {number} processingState - 报警进度的处理状态 [{key: '待处理', value: 1}, {key: '处理中', value: 2}, {key: '已处理', value: 3}, {key: '云呼通知中', value: 4}, {key: '短信通知', value: 5}, {key: '缺岗', value: 6}, {key: '已通知', value: 7}, {key: '真实报警', value: 8}, {key: '测试', value: 9}, {key: '误报', value: 10}, {key: '云呼通知失败', value: 13}, {key: '推送给第三方', value: 14}, {key: '处理完成', value: 15}, {key: '人工处理', value: 16}, {key: '设备自动复位', value: 17}, {key: '短信发送失败', value: 18}, {key: '跟进中', value: 19}]
+ * @property {number} event_time - 报警进度的处理时间 毫秒时间戳。
+ * @property {string} desc - 报警进度的描述。
+ * @example
+ * 
+ {
+    "_id": "67498c0ea2bd800009fa8931",
+    "alarmRecord": "67498c0ea2bd800009fa8906",
+    "processingState": 1,
+    "event_time": 1732873230764,
+    "desc": "通用部件-回路043944节点0155-正常"
+  }
 */
 
 
 /**
- * 获取告警进度列表
+ * 获取报警进度列表
  * @param {Object} query 请求对象
  * @param {number} query.page - 页码
  * @param {number} query.limit - 每页数量
@@ -49,11 +59,11 @@ import { requestShow } from '../utils'
  * @returns {number} code - 返回码，0表示成功
  * @returns {number} total - 报警进度总数
  * @returns {Array} rows - 报警进度数组
- * @returns {Object} data - 见数据类型alarmProgress定义
+ * @returns {Object} data - 见表结构alarmProgress定义
  * @returns {string} data.alarmRecord - 报警记录id
- * @returns {number} data.processingState - 告警进度处理状态 详见数据类型alarmProgress.processingState定义
- * @returns {number} data.event_time - 告警进度的处理时间 毫秒时间戳。
- * @returns {string} data.desc - 告警进度的描述。
+ * @returns {number} data.processingState - 报警进度处理状态 详见表结构alarmProgress.processingState定义
+ * @returns {number} data.event_time - 报警进度的处理时间 毫秒时间戳。
+ * @returns {string} data.desc - 报警进度的描述。
  */
 export function list(query) {
   return requestShow({
@@ -65,9 +75,9 @@ export function list(query) {
 
 /**
  * 新增报警进度记录
- * @param {object} data - 见数据类型alarmProgress定义
+ * @param {object} data - 见表结构alarmProgress定义
  * @returns {number} code - 返回码，0表示成功
- * @returns {Object} data - 见数据类型alarmProgress定义
+ * @returns {Object} data - 见表结构alarmProgress定义
  */
 export function create(data) {
   return requestShow({
@@ -83,7 +93,7 @@ export function create(data) {
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
 * @returns {string} _id - 报警进度id
-* @returns {Object} 见数据类型alarmProgress定义
+* @returns {Object} 见表结构alarmProgress定义
  */
 export function getOne(id) {
   return requestShow({
@@ -97,9 +107,9 @@ export function getOne(id) {
  * 编辑报警进度详情
  * @param {Object} data 修改数据对象
  * @param {string} data._id - 报警进度id
- * @param {Object} data.other 见数据类型alarmProgress定义
+ * @param {Object} data.other 见表结构alarmProgress定义
 * @returns {number} code - 返回码，0表示成功。
-* @returns {Object} data - 报警进度对象 字段见list返回字段
+* @returns {Object} data - 报警进度对象 见表结构alarmProgress定义
  */
 export function updateOne(data) {
   return requestShow({
@@ -114,7 +124,7 @@ export function updateOne(data) {
  * @param {string} id - 报警id 
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
-* @returns {Object} 见数据类型alarmProgress定义
+* @returns {Object} 见表结构alarmProgress定义
  */
 export function deleteOne(id) {
   return requestShow({

package/api/alarmRecord.js

@@ -1,12 +1,291 @@
 /**
  * @file 报警记录api
  * @module 报警记录接口
- * @memberof requestShow
+ * @category 报警模块
  */
 import { requestShow } from '../utils'
 
 /**
- * 获取列表
+ * @typedef {Object} alarmRecord - 报警记录
+ * @property {string} _id - 报警记录id
+ * @property {number} mainType - 告警的主要类型 取value值[{key: '设备告警', value: 1}, {key: '异常告警', value: 2}, {key: '设备故障', value: 3}, {key: '离线告警', value: 4}]。
+ * @property {string} subType - 告警的子类型。
+ * @property {string} device - 关联的设备。
+ * @property {number} event_time - 告警发生的时间（毫秒时间戳）。
+ * @property {string} desc - 告警的描述。
+ * @property {number} number - 告警发生的次数。
+ * @property {number} processingState - 告警的处理状态 取value值[{key: '待处理', value: 1}, {key: '处理中', value: 2}, {key: '已处理', value: 3}]。
+ * @property {number} processingResult - 处理结果 取value值[{key: '云呼通知失败', value: 9}, {key: '缺岗', value: 10}, {key: '短信发送失败', value: 12}, {key: '已通知', value: 1}, {key: '云呼通知中', value: 11}, {key: '真实告警', value: 2}, {key: '测试', value: 3}, {key: '误报', value: 4}, {key: '处理完成', value: 5}, {key: '人工处理', value: 6}, {key: '设备自动复位', value: 7}, {key: '已推送至第三方', value: 8}]。
+ * @property {number} noticeWay - 通知方式 取value值[{key: '云呼', value: 1}, {key: '短信', value: 2}, {key: '人工通知', value: 3}]。
+ * @property {string} fireDesc - 火灾事件的描述。
+ * @property {number} lastSmsTime - 最后发送短信的时间 毫秒时间戳。
+ * @property {number} lastCallTime - 最后发送云呼的时间 毫秒时间戳。
+ * @property {string} confirmPersonName - 处理告警的人员姓名。
+ * @property {number} disposalDuration - 处置时长 毫秒时间戳。
+ * @property {number} processingTime - 已处理的时间 毫秒时间戳。
+ * @property {Array} picUrls - 告警图片的URL。
+ * @property {string} wxUser - 关联的微信用户。
+ * @property {string} creator - 关联的用户。
+ * @property {Date} createdAt - 告警记录的创建日期。
+ * @property {Date} updatedAt - 告警记录的最后更新日期。
+ * @example
+ * {
+    "picUrls": [],
+    "alarmTimes": [
+        1732846021953
+    ],
+    "_id": "674921c6b9c0f70009320efc",
+    "mainType": 1,
+    "subType": "门禁告警",
+    "device": {
+        "hash": [],
+        "latLng": [],
+        "mapLatLng": [],
+        "deviceStatus": 1,
+        "_id": "6742de025872200009a89da5",
+        "name": "门口门禁",
+        "n_device": "6742ddd5c76eb9bca326279e",
+        "deviceClass": "667d32ed52d21700095b60c8",
+        "creator": "6678e31ff340dfdecd9e1a28",
+        "attribute": [],
+        "props": [
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89dd7",
+                "name": "门禁反控",
+                "key": "门禁反控",
+                "type": "operate",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89dd8",
+                "name": "在离线状态",
+                "key": "在离线状态",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89dd9",
+                "name": "读卡器在离线状态",
+                "key": "读卡器在离线状态",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89dda",
+                "name": "进出类型",
+                "key": "进出类型",
+                "type": "check",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89ddb",
+                "name": "事件类型",
+                "key": "事件类型",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89ddc",
+                "name": "事件时间",
+                "key": "事件时间",
+                "type": "check",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89ddd",
+                "name": "图片地址",
+                "key": "图片地址",
+                "type": "check",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89dde",
+                "name": "卡号",
+                "key": "卡号",
+                "type": "check",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89ddf",
+                "name": "姓名",
+                "key": "姓名",
+                "type": "check",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89de0",
+                "name": "事件详情数据",
+                "key": "事件详情数据",
+                "type": "check",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89de1",
+                "name": "门状态",
+                "key": "门状态",
+                "enum": []
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "6742de1d5872200009a89de2",
+                "name": "批量下发人脸",
+                "key": "批量下发人脸",
+                "type": "operate",
+                "enum": []
+            }
+        ],
+        "__v": 1,
+        "createdAt": "2024-11-24T08:04:18.733Z",
+        "updatedAt": "2024-11-29T02:07:02.042Z",
+        "depart": "667bc7bb92f8ed0009c55baa"
+    },
+    "event_time": 1732846021953,
+    "desc": "电压报警",
+    "number": 1,
+    "processingState": 1,
+    "noticeWay": 1,
+    "creator": "6678e31ff340dfdecd9e1a28",
+    "deviceClass": {
+        "_id": "667d32ed52d21700095b60c8",
+        "name": "人脸门禁",
+        "code": "23",
+        "deviceUI": "667cd976a50c768b72352a53",
+        "creator": "6678e31ff340dfdecd9e1a28",
+        "attributes": [
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284db",
+                "name": "门禁反控",
+                "key": "门禁反控",
+                "type": "operate"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284dc",
+                "name": "在离线状态",
+                "key": "在离线状态",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284dd",
+                "name": "读卡器在离线状态",
+                "key": "读卡器在离线状态",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284de",
+                "name": "进出类型",
+                "key": "进出类型",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284df",
+                "name": "事件类型",
+                "key": "事件类型",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284e0",
+                "name": "事件时间",
+                "key": "事件时间",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284e1",
+                "name": "图片地址",
+                "key": "图片地址",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284e2",
+                "name": "卡号",
+                "key": "卡号",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284e3",
+                "name": "姓名",
+                "key": "姓名",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284e4",
+                "name": "事件详情数据",
+                "key": "事件详情数据",
+                "type": "check"
+            },
+            {
+                "dataDimension": "day",
+                "lineTime": 4,
+                "_id": "673edcc49f45440009c284e5",
+                "name": "门状态",
+                "key": "门状态",
+                "type": "check"
+            }
+        ],
+        "relations": [],
+        "uis": [
+            {
+                "type": "ba_card",
+                "attrs": [],
+                "_id": "667fbc7c7a5ce90009d239f9",
+                "uiId": "667d294a52d21700095b530b",
+                "uiName": "BA人脸门禁",
+                "uiCode": "NaFaceAccessCard"
+            }
+        ],
+        "createdAt": "2024-06-27T09:37:49.345Z",
+        "updatedAt": "2024-11-21T07:09:56.257Z",
+        "__v": 2,
+        "icon": "人脸识别 (30)",
+        "isSimulation": true
+    },
+    "createdAt": "2024-11-29T02:07:02.032Z",
+    "updatedAt": "2024-11-29T02:07:02.032Z",
+    "__v": 0
+}
+ */
+
+/**
+ * 获取报警记录列表
  * @param {*} query
  * @param {number} query.page - 页码
  * @param {number} query.limit - 每页数量
@@ -15,27 +294,7 @@ import { requestShow } from '../utils'
  * @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 - 告警记录的最后更新日期。
+ * @returns {Array} rows - 报警记录数组 见表结构alarmRecord定义
  */
 export function list(query) {
   return requestShow({
@@ -47,7 +306,7 @@ export function list(query) {
 
 /**
  * 新增报警记录
- * @param {Object} data - 包含报警记录的请求体 属性见list返回字段。
+ * @param {Object} data - 包含报警记录的请求体 见表结构alarmRecord定义
  */
 export function create(data) {
   return requestShow({
@@ -58,22 +317,74 @@ export function create(data) {
 }
 
 /**
-  * 根据提供的参数检索报警计数。
-  *
+ * 获取报警详情
+ * @param {string} id - 报警id
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 报警记录对象 见表结构alarmRecord定义
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/alarm-records/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 编辑报警详情
+ * @param {Object} data 修改数据对象
+  * @returns {number} code - 返回码，0表示成功。
+  * @returns {Object} data - 报警记录对象 见表结构alarmRecord定义
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/alarm-records/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除报警
+ * @param {string} id - 报警id
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 报警记录对象 见表结构alarmRecord定义
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/alarm-records/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除报警
+ * @param {Array} ids - 报警ids
+* @returns {number} code - 返回码，0表示成功。
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/alarm-records',
+    method: 'delete',
+    data: ids // delete传递主体要包含在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表示成功）。
+  * @returns {number} code - 状态码（0表示成功）
+  * @returns {Object} data - 包含报警计数的结果对象
+  * @returns {number} data.total - 报警的总数
+  * @returns {number} data.todayTotal - 今天发生的报警数量
+  * @returns {number} data.monthTotal - 当前月份发生的报警数量
+  * @returns {number} data.processed - 已处理的报警数量
+  * @returns {number} data.waitProcess - 等待处理的报警数量
+  * @returns {number} data.processing - 正在处理的报警数量
   */
 export function getAlarmCount(data) {
   return requestShow({
@@ -105,30 +416,26 @@ export function getAlarmTotalCount(data) {
 
 /**
  * 人员测试云呼
- * @param {*} data 目前不用传此参数
  * @returns {Object} - 包含报警总数的对象
  * @returns {number} code - 返回码，0表示成功
  * @returns {string} message - 错误描述
  */
-export function cloudCall(data) {
+export function cloudCall() {
   return requestShow({
     url: '/alarm-records/cloud-call',
-    method: 'post',
-    data
+    method: 'post'
   })
 }
 
 /**
  * 报警云呼 用于报警页面通知人员
- * @param {*} data 目前不用传此参数
- * @returns {Object} - 返回对象
- * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 返回对象
+ * @returns {number} data.code - 返回码，0表示成功
  */
-export function alarmCloudCall(data) {
+export function alarmCloudCall() {
   return requestShow({
     url: '/alarm-records/alarm-cloud-call',
-    method: 'post',
-    data
+    method: 'post'
   })
 }
 
@@ -137,13 +444,13 @@ export function alarmCloudCall(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 {number} data.query.mainType - 查询告警的主要类型[{key: '设备告警', value: 1}, {key: '异常告警', value: 2}, {key: '设备故障', value: 3}, {key: '离线告警', value: 4}]
  * @param {Array} data.query.range - 查询的时间范围[开始毫秒时间戳，结束毫秒时间戳]
- * @param {number} data.query.processingState - 查询的告警的处理状态（1：待处理，2：处理中，3：已处理）
+ * @param {number} data.query.processingState - 查询的告警的处理状态[{key: '待处理', value: 1}, {key: '处理中', value: 2}, {key: '已处理', value: 3}]
  * @param {Array} data.alarmRecords - 待处理的报警记录id数组
- * @param {number} data.processingResult - 处理结果（9：云呼通知失败，10：缺岗，12：短信发送失败，1：已通知，11：云呼通知中，2：真实告警，3：测试，4：误报，5：处理完成，6：人工处理，7：设备自动复位，8：已推送至第三方）
+ * @param {number} data.processingResult - 处理结果 [{key: '已通知', value: 1}, {key: '真实告警', value: 2}, {key: '测试', value: 3}, {key: '误报', value: 4}, {key: '处理完成', value: 5}, {key: '人工处理', value: 6}, {key: '设备自动复位', value: 7}, {key: '已推送至第三方', value: 8}, {key: '云呼通知失败', value: 9}, {key: '缺岗', value: 10}, {key: '云呼通知中', value: 11}, {key: '短信发送失败', value: 12}]
  * @param {string} data.fireDesc - 报警描述
- * @returns {Object} - 返回对象
+ * @returns {Object} data - 返回对象
  * @returns {number} code - 返回码，0表示成功
  * @example <caption>请求范例</caption>
  * 当isAll为true时，传以下参数。代表处理条件内的所有报警记录
@@ -175,15 +482,14 @@ export function processingManyAlarm(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表示成功。
+   * @returns {Object} data - 返回对象
+   * @returns {number} code - 返回码，0表示成功
    */
 // export function uploadTroubleAlarm(data) {
 //   return requestShow({
@@ -194,13 +500,10 @@ export function processingManyAlarm(data) {
 // }
 
 /**
-   * 报警记录导出excel。
-   *
+   * 报警记录导出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 - 描述。
@@ -213,70 +516,12 @@ export function exportAlarmRecord(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 - 格式化后的时间字符串
@@ -305,6 +550,5 @@ export default {
   cloudCall,
   alarmCloudCall,
   processingManyAlarm,
-  // uploadTroubleAlarm,
   exportAlarmRecord
 }

package/api/appRouter.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 看板路由api
  * @module 看板路由接口
+ * @category 看板管理
  */
 
 

package/api/application.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 应用信息api
  * @module 应用信息接口
+ * @category 系统设置
  */
 
 

package/api/bmsRole.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file BMS角色api
  * @module BMS角色接口
+ * @category BMS管理
  */
 
 

package/api/bmsRouter.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file BMS路由api
  * @module BMS路由接口
+ * @category BMS管理
  */
 
 

package/api/components.js

@@ -2,6 +2,8 @@ import { requestShow } from '../utils'
 /**
  * @file 系统组件api
  * @module 系统组件接口
+ * @category 系统设置
+ * @subcategory 系统组件
  */
 
 /**

package/api/departs.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 层级api
  * @module 层级接口
+ * @category 系统设置
  */
 /**
  * 

package/api/deviceClass.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 设备类型api
  * @module 设备类型接口
+ * @category 设备管理
  */
 
 

package/api/devices.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 设备api
  * @module 设备接口
+ * @category 设备管理
  */
 
 

package/api/inspectionPoints.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 点位api
  * @module 点位接口
+ * @category 巡更管理
  */
 
 

package/api/inspectionTask.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 巡查任务api
  * @module 巡查任务接口
+ * @category 巡更管理
  */
 
 

package/api/inspectionTaskSub.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 巡查任务子表api
  * @module 巡查任务子表接口
+ * @category 巡更管理
  */
 
 

package/api/line.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 路线api
  * @module 路线接口
+ * @category 巡更管理
  */
 
 

package/api/product.js

@@ -2,6 +2,7 @@
  * @file 产品管理api
  * @module 产品管理接口
  * @memberof requestShow
+ * @category 产品管理
  */
 import { requestShow } from '../utils'
 

package/api/relationPlatform.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 关联平台api
  * @module 关联平台接口
+ * @category 系统设置
  */
 
 /**

package/api/router.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 路由api
  * @module 路由接口
+ * @category 系统设置
  */
 
 /**
@@ -17,10 +18,10 @@ import { requestShow } from '../utils'
  * @returns {string} rows.path - 路由路径
  * @returns {number} rows.level - 路由等级
  * @returns {number} rows.sort - 排序序号
- * @returns {Array<mongoose.Schema.Types.ObjectId>} rows.children - 子路由列表
+ * @returns {Array<string>} rows.children - 子路由列表
  * @returns {('all'|'get'|'post'|'put'|'delete')} rows.method - HTTP请求方法
  * @returns {string} rows.desc - 路由描述
- * @returns {Array<mongoose.Schema.Types.ObjectId>} rows.roles - 关联的角色列表
+ * @returns {Array<string>} rows.roles - 关联的角色列表
  */
 export function list(query) {
   return requestShow({

package/api/svglib.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 图标api
  * @module 图标接口
+ * @category 系统设置
  */
 
 

package/api/systeminfo.js

@@ -2,6 +2,7 @@
  * @file 系统信息api
  * @module 系统信息接口
  * @memberof requestShow
+ * @category 系统设置
  */
 import { requestShow } from '../utils'
 /**

package/api/tag.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 层级标签api
  * @module 层级标签接口
+ * @category 系统设置
  */
 
 

package/api/upload.js

@@ -2,21 +2,21 @@ import { requestShow, requestForm } from '../utils'
 /**
  * @file 文件管理api
  * @module 文件管理接口
+ * @category 文件管理
  */
 
 
 /**
- * 文件来源from
  * @readonly
  * @enum {number}
  */
-var from = {
+var 文件来源枚举 = {
   默认文件: 0,
   展示文件: 1
 }
 
 /**
- * 
+ * 获取列表
  * @param {*} query
  * @param {number} query.page - 页码
  * @param {number} query.limit - 每页数量

package/api/userDevice.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 用户权限配置api
  * @module 用户权限配置接口
+ * @category 系统设置
  */
 
 

package/api/video.js

@@ -2,6 +2,7 @@ import { requestShow } from '../utils'
 /**
  * @file 视频转码api
  * @module 视频转码接口
+ * @category 视频管理（即将废弃）
  */
 
 

package/api/view.js

@@ -2,23 +2,22 @@ import { requestShow } from '../utils'
 /**
  * @file 看板页面api
  * @module 看板页面接口
+ * @category 看板管理
  */
 
 
 /**
  * 页面类型type
- * @readonly
- * @enum {string}
+ * @enum {string}   
  */
 var type = {
-  基础: 'base',
-  设备UI: 'layoutDevicePanel',
-  摄像头: 'videosPanel'
+  "基础": 'base',
+  "设备UI": 'layoutDevicePanel',
+  "摄像头": 'videosPanel'
 }
 
 /**
  * UI类型uiType
- * @readonly
  * @enum {string}
  */
 var uiType = {

package/betterDoc.json

@@ -0,0 +1,33 @@
+{
+    "plugins": ["node_modules/better-docs-nayota/typescript", "node_modules/better-docs-nayota/category"],
+    "recurseDepth": 10,
+    "source": {
+        "include": [
+            "api"
+        ],
+        "includePattern": ".+\\.js(doc|x)?$",
+        "excludePattern": "(^|\\/|\\\\)_"
+    },
+    "sourceType": "module",
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false,
+        "search": true,
+        "better-docs": {
+            "name": "NAYOTA可视化系统SDK",
+            "title": "NAYOTA可视化系统SDK",
+            "hideGenerator": true
+        }
+    },
+    "opts": {
+        "encoding": "utf8",
+        "readme": "README.md",
+        "recurse": true,
+        "verbose": true,
+        "sort": false,
+        "template": "node_modules/better-docs-nayota"
+    }
+}

package/{jsdoc.json → jsdoc1.json}

@@ -1,5 +1,5 @@
 {
-    "plugins": [],
+    "plugins": ["plugins/markdown"],
     "recurseDepth": 10,
     "source": {
         "include": [
@@ -20,16 +20,16 @@
         "systemName": "nayota-show-sdk",
         "footer": "宁波边缘物联有限公司",
         "copyright": "宁波边缘物联有限公司",
-        "navType": "vertical",
+        "navType": "classic‌",
         "theme": "cerulean",
         "linenums": true,
         "collapseSymbols": false,
         "inverseNav": false,
-        "outputSourceFiles": true,
-        "outputSourcePath": true,
+        "outputSourceFiles": false,
+        "outputSourcePath": false,
         "dateFormat": "MMMM Do YYYY, h:mm:ss a",
         "syntaxTheme": "default",
-        "sort": true,
-        "search": true
+        "sort": "alarmRecord,application,device",
+        "search": false
     }
 }

package/package.json

@@ -1,17 +1,18 @@
 {
   "name": "nayota-show-sdk",
-  "version": "1.1.2",
+  "version": "1.1.3",
   "description": "nayota-show-server rest-api",
   "type": "module",
   "main": "index.js",
   "author": "lifeng",
   "license": "MIT",
   "scripts": {
-    "doc": "jsdoc -c jsdoc.json -t ./node_modules/ink-docstrap/template -R README.md -r",
+    "doc": "jsdoc -c betterDoc.json",
     "test": "jest --config jest.config.cjs"
   },
   "dependencies": {
     "axios": "^1.6.8",
+    "better-docs-nayota": "0.1.4",
     "cookie-es": "^1.1.0"
   },
   "devDependencies": {