nayota-show-sdk 1.2.0 → 1.2.2

package/README.md

@@ -2,7 +2,7 @@
 
 
 ## 1. SDK简介
-nayota开放SDK是为了方便开发者快速接入nayota平台而提供的一套开发工具包。SDK提供了一系列的API接口，开发者可以通过调用这些接口实现与nayota平台的交互。
+Nayota开放SDK是为了方便开发者快速接入Nayota平台而提供的一套开发工具包。SDK提供了一系列的API接口，开发者可以通过调用这些接口实现与Nayota平台的交互。
 
 ## 2. SDK npm 安装
 ```shell
@@ -17,4 +17,10 @@ NayotaSdk.config({
   authTokenName: 'Admin-Token', // api接口存储的token到cookie的key名称
   showServer: 'http://localhost:8080/api', // noyota-impossible-pro配置服务地址
 })
+// 调用你需要的模块名称
+import { alarmRecord } from 'nayota-show-sdk'
+// 引入接口模块的方法
+const { list, updateOne, create, delete } = alarmRecord
+// 正常调用
+list({ page:1, limit:50 })
 ```

package/api/alarmProgress.js

@@ -1,15 +1,19 @@
 /**
- * @file 报警进度接口
+ * @file 报警进度api
  * @module 报警进度接口
- * @category 报警模块
+ * @category 报警管理
+ * @import
+ * import { alarmProgress } from 'nayota-show-sdk'
+ * const { list, getOne, create, updateOne, deleteOne, deleteMany } = alarmProgress
+ * list({ page: 1, limit: 50 })
  */
 import { requestShow } from '../utils'
 
 
 /**
- * @typedef {Object} alarmProgress - 报警进度
+ * @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} processingState - 报警进度的处理状态 [{name: '待处理', value: 1}, {name: '处理中', value: 2}, {name: '已处理', value: 3}, {name: '云呼通知中', value: 4}, {name: '短信通知', value: 5}, {name: '缺岗', value: 6}, {name: '已通知', value: 7}, {name: '真实报警', value: 8}, {name: '测试', value: 9}, {name: '误报', value: 10}, {name: '云呼通知失败', value: 13}, {name: '推送给第三方', value: 14}, {name: '处理完成', value: 15}, {name: '人工处理', value: 16}, {name: '设备自动复位', value: 17}, {name: '短信发送失败', value: 18}, {name: '跟进中', value: 19}]
  * @property {number} event_time - 报警进度的处理时间 毫秒时间戳。
  * @property {string} desc - 报警进度的描述。
  * @example
@@ -32,9 +36,24 @@ import { requestShow } from '../utils'
  * @param {string} query.label - 模糊查询关键字
  * @param {string} query.search - 模糊查询内容
  * @param {string} query.alarmRecord - 关联到AlarmRecord的引用。
+ * @example
+ * { page: 1, limit: 10, label: 'desc', search: '报警', alarmRecord: '67498c0ea2bd800009fa8906' }
  * @returns {number} code - 返回码，0表示成功
  * @returns {number} total - 报警进度总数
  * @returns {Array} rows - 报警进度数组 见表结构alarmProgress定义
+ * @example
+ * {
+ *   "code": 0,
+ *   "total": 1,
+ *   "rows": [
+      {
+        "_id": "67498c0ea2bd800009fa8931",
+        "alarmRecord": "67498c0ea2bd800009fa8906",
+        "processingState": 1,
+        "event_time": 1732873230764,
+        "desc": "通用部件-回路043944节点0155-正常"
+      }
+    ]}
  */
 export function list(query) {
   return requestShow({
@@ -47,8 +66,26 @@ export function list(query) {
 /**
  * 新增报警进度记录
  * @param {object} data - 见表结构alarmProgress定义
+ * @example
+ * {
+    "alarmRecord": "67498c0ea2bd800009fa8906",
+    "processingState": 1,
+    "event_time": 1732873230764,
+    "desc": "通用部件-回路043944节点0155-正常"
+  }
  * @returns {number} code - 返回码，0表示成功
  * @returns {Object} data - 见表结构alarmProgress定义
+ * @example
+ * {
+ *   "code": 0,
+ *   "data": {
+ *     "_id": "67498c0ea2bd800009fa8931",
+ *     "alarmRecord": "67498c0ea2bd800009fa8906",
+ *     "processingState": 1,
+ *     "event_time": 1732873230764,
+ *     "desc": "通用部件-回路043944节点0155-正常"
+ *   }
+ * }
  */
 export function create(data) {
   return requestShow({
@@ -61,10 +98,21 @@ export function create(data) {
 /**
  * 获取报警进度详情
  * @param {string} id - 报警id 
-* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
-* @returns {number} code - 返回码，0表示成功。
-* @returns {string} _id - 报警进度id
-* @returns {Object} 见表结构alarmProgress定义
+ * @example
+ * 67498c0ea2bd800009fa8931
+ * @returns {number} code - 返回码，0表示成功。
+ * @returns {Object} data - 见表结构alarmProgress定义
+ * @example
+ * {
+ *   "code": 0,
+ *   "data": {
+ *     "_id": "67498c0ea2bd800009fa8931",
+ *     "alarmRecord": "67498c0ea2bd800009fa8906",
+ *     "processingState": 1,
+ *     "event_time": 1732873230764,
+ *     "desc": "通用部件-回路043944节点0155-正常"
+ *   }
+ }
  */
 export function getOne(id) {
   return requestShow({
@@ -77,10 +125,27 @@ export function getOne(id) {
 /**
  * 编辑报警进度详情
  * @param {Object} data 修改数据对象
- * @param {string} data._id - 报警进度id
- * @param {Object} data.other 见表结构alarmProgress定义
+ * @example
+ * {
+    "_id": "67498c0ea2bd800009fa8931",
+    "alarmRecord": "67498c0ea2bd800009fa8906",
+    "processingState": 1,
+    "event_time": 1732873230764,
+    "desc": "通用部件-回路043944节点0155-正常"
+ }
 * @returns {number} code - 返回码，0表示成功。
 * @returns {Object} data - 报警进度对象 见表结构alarmProgress定义
+* @example
+* {
+*   "code": 0,
+*   "data": {
+*     "_id": "67498c0ea2bd800009fa8931",
+*     "alarmRecord": "67498c0ea2bd800009fa8906",
+*     "processingState": 1,
+*     "event_time": 1732873230764,
+*     "desc": "通用部件-回路043944节点0155-正常"
+*   }
+* }
  */
 export function updateOne(data) {
   return requestShow({
@@ -93,9 +158,21 @@ export function updateOne(data) {
 /**
  * 删除进度
  * @param {string} id - 报警id 
-* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+ * @example
+ * 67498c0ea2bd800009fa8931
 * @returns {number} code - 返回码，0表示成功。
-* @returns {Object} 见表结构alarmProgress定义
+* @returns {Object} data - 见表结构alarmProgress定义
+* @example
+* {
+*   "code": 0,
+*   "data": {
+*     "_id": "67498c0ea2bd800009fa8931",
+*     "alarmRecord": "67498c0ea2bd800009fa8906",
+*     "processingState": 1,
+*     "event_time": 1732873230764,
+*     "desc": "通用部件-回路043944节点0155-正常"
+*   }
+* }
  */
 export function deleteOne(id) {
   return requestShow({
@@ -107,8 +184,14 @@ export function deleteOne(id) {
 /**
  * 批量删除报警进度
  * @param {Array} ids - 报警进度ids 
+ * @example
+ * ['67498c0ea2bd800009fa8931', '67498c0ea2bd800009fa8932']
 * @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
 * @returns {number} code - 返回码，0表示成功。
+* @example
+* {
+*   "code": 0
+* }
  */
 export function deleteMany(ids) {
   return requestShow({

package/api/alarmRecord.js

@@ -1,22 +1,28 @@
+import { requestShow } from '../utils'
 /**
  * @file 报警记录api
  * @module 报警记录接口
- * @category 报警模块
+ * @category 报警管理
+ * @categoryOrder 4
+ * @import
+ * import { alarmRecord } from 'nayota-show-sdk'
+ * const { list, getOne, create, updateOne, deleteOne, deleteMany, getAlarmCount, getAlarmTotalCount, getMoreAlarmCount, cloudCall, alarmCloudCall, processingManyAlarm, exportAlarmRecord } = alarmRecord
+ * list({ page: 1, limit: 50 })
  */
-import { requestShow } from '../utils'
+
 
 /**
- * @typedef {Object} alarmRecord - 报警记录
+ * @typedef {Object} AlarmRecord - 报警记录
  * @property {string} _id - 报警记录id
- * @property {number} mainType - 告警的主要类型 取value值[{key: '设备告警', value: 1}, {key: '异常告警', value: 2}, {key: '设备故障', value: 3}, {key: '离线告警', value: 4}]。
+ * @property {number} mainType - 告警的主要类型 取value值[{name: '设备告警', value: 1}, {name: '异常告警', value: 2}, {name: '设备故障', value: 3}, {name: '离线告警', 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 {number} processingState - 告警的处理状态 取value值[{name: '待处理', value: 1}, {name: '处理中', value: 2}, {name: '已处理', value: 3}]。
+ * @property {number} processingResult - 处理结果 取value值[{name: '云呼通知失败', value: 9}, {name: '缺岗', value: 10}, {name: '短信发送失败', value: 12}, {name: '已通知', value: 1}, {name: '云呼通知中', value: 11}, {name: '真实告警', value: 2}, {name: '测试', value: 3}, {name: '误报', value: 4}, {name: '处理完成', value: 5}, {name: '人工处理', value: 6}, {name: '设备自动复位', value: 7}, {name: '已推送至第三方', value: 8}]。
+ * @property {number} noticeWay - 通知方式 取value值[{name: '云呼', value: 1}, {name: '短信', value: 2}, {name: '人工通知', value: 3}]。
  * @property {string} fireDesc - 火灾事件的描述。
  * @property {number} lastSmsTime - 最后发送短信的时间 毫秒时间戳。
  * @property {number} lastCallTime - 最后发送云呼的时间 毫秒时间戳。
@@ -291,9 +297,17 @@ import { requestShow } from '../utils'
  * @param {number} query.limit - 每页数量
  * @param {string} query.label - 模糊查询关键字
  * @param {string} query.search - 模糊查询内容
+ * @example 
+ * { page: 1, limit: 10, label: 'desc', search: '报警' }
  * @returns {number} code - 返回码，0表示成功
  * @returns {number} total - 报警记录总数
- * @returns {Array} rows - 报警记录数组 见表结构alarmRecord定义
+ * @returns {Array} rows - 报警记录数组 见表结构AlarmRecord定义
+ * @example
+ * {
+    "code": 0,
+    "total": 1,
+    "rows": [] // 数组对象内容见表结构AlarmRecord定义
+ }
  */
 export function list(query) {
   return requestShow({
@@ -306,8 +320,47 @@ export function list(query) {
 /**
  * 新增报警记录
  * @param {Object} data - 包含报警记录的请求体 见表结构alarmRecord定义
+ * @example
+ * {
+    "picUrls": [],
+    "alarmTimes": [
+        1732846021953
+    ],
+    "_id": "674921c6b9c0f70009320efc",
+    "mainType": 1,
+    "subType": "门禁告警",
+    "deviceClass": "667d32ed52d21700095b60c8",
+    "device": "6742de025872200009a89da5",
+    "event_time": 1732846021953,
+    "desc": "电压报警",
+    "number": 1,
+    "processingState": 1,
+    "noticeWay": 1,
+    "depart": "667bc7bb92f8ed0009c55baa"
+ }
  * @returns {number} code - 返回码，0表示成功
  * @returns {string} data - 新增成功的数据 见表结构alarmRecord定义
+ * @example
+ * {
+    "code": 0,
+    "data": {
+        "_id": "674921c6b9c0f70009320efc",
+        "picUrls": [],
+        "alarmTimes": [
+            1732846021953
+        ],
+        "mainType": 1,
+        "subType": "门禁告警",
+        "deviceClass": "667d32ed52d21700095b60c8",
+        "device": "6742de025872200009a89da5",
+        "event_time": 1732846021953,
+        "desc": "电压报警",
+        "number": 1,
+        "processingState": 1,
+        "noticeWay": 1,
+        "depart": "667bc7bb92f8ed0009c55baa"
+    }
+ }
  */
 export function create(data) {
   return requestShow({
@@ -320,8 +373,30 @@ export function create(data) {
 /**
  * 获取报警详情
  * @param {string} id - 报警id
+ * @example
+ * 67498c0ea2bd800009fa8931
 * @returns {number} code - 返回码，0表示成功。
 * @returns {Object} data - 报警记录对象 见表结构alarmRecord定义
+* @example
+* {
+*   "code": 0,
+*   "data": {
+*     "_id": "67498c0ea2bd800009fa8931",
+*     "picUrls": [],
+*     "alarmTimes": [
+*         1732846021953
+*     ],
+*     "mainType": 1,
+*     "subType": "门禁告警",
+*     "deviceClass": "667d32ed52d21700095b60c8",
+*     "device": "6742de025872200009a89da5",
+*     "event_time": 1732846021953,
+*     "desc": "电压报警",
+*     "number": 1,
+*     "processingState": 1,
+*     "noticeWay": 1,
+*     "depart": "667bc7bb92f8ed0009c55baa"
+*   }
  */
 export function getOne(id) {
   return requestShow({
@@ -333,8 +408,47 @@ export function getOne(id) {
 /**
  * 编辑报警详情
  * @param {Object} data - 修改数据对象
+ * @example
+ * {
+    "_id": "67498c0ea2bd800009fa8931",
+    "picUrls": [],
+    "alarmTimes": [
+        1732846021953
+    ],
+    "mainType": 1,
+    "subType": "门禁告警",
+    "deviceClass": "667d32ed52d21700095b60c8",
+    "device": "6742de025872200009a89da5",
+    "event_time": 1732846021953,
+    "desc": "电压报警",
+    "number": 1,
+    "processingState": 1,
+    "noticeWay": 1,
+    "depart": "667bc7bb92f8ed0009c55baa"
+ }
   * @returns {number} code - 返回码，0表示成功。
   * @returns {Object} data - 报警记录对象 见表结构alarmRecord定义
+  * @example
+  * {
+  *   "code": 0,
+  *   "data": {
+  *     "_id": "67498c0ea2bd800009fa8931",
+  *     "picUrls": [],
+  *     "alarmTimes": [
+  *         1732846021953
+  *     ],
+  *     "mainType": 1,
+  *     "subType": "门禁告警",
+  *     "deviceClass": "667d32ed52d21700095b60c8",
+  *     "device": "6742de025872200009a89da5",
+  *     "event_time": 1732846021953,
+  *     "desc": "电压报警",
+  *     "number": 1,
+  *     "processingState": 1,
+  *     "noticeWay": 1,
+  *     "depart": "667bc7bb92f8ed0009c55baa"
+  *   }
+  }
  */
 export function updateOne(data) {
   return requestShow({
@@ -347,8 +461,31 @@ export function updateOne(data) {
 /**
  * 删除报警
  * @param {string} id - 报警id
+ * @example
+ * 67498c0ea2bd800009fa8931
 * @returns {number} code - 返回码，0表示成功。
 * @returns {Object} data - 报警记录对象 见表结构alarmRecord定义
+* @example
+* {
+*   "code": 0,
+*   "data": {
+*     "_id": "67498c0ea2bd800009fa8931",
+*     "picUrls": [],
+*     "alarmTimes": [
+*         1732846021953
+*     ],
+*     "mainType": 1,
+*     "subType": "门禁告警",
+*     "deviceClass": "667d32ed52d21700095b60c8",
+*     "device": "6742de025872200009a89da5",
+*     "event_time": 1732846021953,
+*     "desc": "电压报警",
+*     "number": 1,
+*     "processingState": 1,
+*     "noticeWay": 1,
+*     "depart": "667bc7bb92f8ed0009c55baa"
+*   }
+* }
  */
 export function deleteOne(id) {
   return requestShow({
@@ -360,7 +497,13 @@ export function deleteOne(id) {
 /**
  * 批量删除报警
  * @param {Array} ids - 报警ids
+ * @example
+ * ['67498c0ea2bd800009fa8931', '67498c0ea2bd800009fa8932']
 * @returns {number} code - 返回码，0表示成功。
+* @example
+* {
+*   "code": 0
+* }
  */
 export function deleteMany(ids) {
   return requestShow({
@@ -378,6 +521,17 @@ export function deleteMany(ids) {
   * @param {Date} data.endTime - 用于过滤报警的结束时间 毫秒时间戳（可选）。
   * @param {Date} data.startMonth - 用于过滤报警的开始月份 毫秒时间戳（可选）。
   * @param {Date} data.endMonth - 用于过滤报警的结束月份 毫秒时间戳（可选）。
+  * @example
+  * {
+  "mainType": 1,
+  "startTime": 1733016332000,
+  "endTime": 1735608332000
+  }
+  {
+  "mainType": 1,
+  "startMonth": 1733016332000,
+  "endMonth": 1735608332000
+  }
   * @returns {number} code - 状态码（0表示成功）
   * @returns {Object} data - 包含报警计数的结果对象
   * @returns {number} data.total - 报警的总数
@@ -386,6 +540,17 @@ export function deleteMany(ids) {
   * @returns {number} data.processed - 已处理的报警数量
   * @returns {number} data.waitProcess - 等待处理的报警数量
   * @returns {number} data.processing - 正在处理的报警数量
+  * @example
+  * {
+  "code": 0,
+  "data": {
+    "total": 0,
+    "todayTotal": 0,
+    "monthTotal": 0,
+    "processed": 0,
+    "waitProcess": 0,
+    "processing": 0
+  }
   */
 export function getAlarmCount(data) {
   return requestShow({
@@ -397,7 +562,6 @@ export function getAlarmCount(data) {
 
 /**
  * 获取报警未处理和处理中的总数
- * @param {Object} data - 请求体参数 目前不用传此参数
  * @returns {Object} - 包含报警总数的对象
  * @returns {number} code - 返回码，0表示成功
  * @returns {Object} data - 报警总数对象
@@ -406,54 +570,39 @@ export function getAlarmCount(data) {
  * @returns {number} data.errorCount - 设备异常总数
  * @returns {number} data.troubleCount - 设备故障总数
  * @returns {number} data.offlineCount - 设备离线总数
+ * @example
+ * {
+  "code": 0,
+  "data": {
+    "total": 0,
+    "deviceCount": 0,
+    "errorCount": 0,
+    "troubleCount": 0,
+    "offlineCount": 0
+  }
+ }
  */
-export function getAlarmTotalCount(data) {
+export function getAlarmTotalCount() {
   return requestShow({
     url: '/alarm-records/alarm-total-count',
-    method: 'post',
-    data
-  })
-}
-
-/**
- * 人员测试云呼
- * @returns {Object} - 包含报警总数的对象
- * @returns {number} code - 返回码，0表示成功
- * @returns {string} message - 错误描述
- */
-export function cloudCall() {
-  return requestShow({
-    url: '/alarm-records/cloud-call',
     method: 'post'
   })
 }
 
-/**
- * 报警云呼 用于报警页面通知人员
- * @returns {Object} data - 返回对象
- * @returns {number} data.code - 返回码，0表示成功
- */
-export function alarmCloudCall() {
-  return requestShow({
-    url: '/alarm-records/alarm-cloud-call',
-    method: 'post'
-  })
-}
+
 
 /**
  * 批量处理
  * @param {Object} data 处理参数对象
  * @param {boolean} data.isAll - 是否全部处理
  * @param {Object} data.query - 查询参数对象 当isAll为true时，query必传
- * @param {number} data.query.mainType - 查询告警的主要类型[{key: '设备告警', value: 1}, {key: '异常告警', value: 2}, {key: '设备故障', value: 3}, {key: '离线告警', value: 4}]
+ * @param {number} data.query.mainType - 查询告警的主要类型[{name: '设备告警', value: 1}, {name: '异常告警', value: 2}, {name: '设备故障', value: 3}, {name: '离线告警', value: 4}]
  * @param {Array} data.query.range - 查询的时间范围[开始毫秒时间戳，结束毫秒时间戳]
- * @param {number} data.query.processingState - 查询的告警的处理状态[{key: '待处理', value: 1}, {key: '处理中', value: 2}, {key: '已处理', value: 3}]
+ * @param {number} data.query.processingState - 查询的告警的处理状态[{name: '待处理', value: 1}, {name: '处理中', value: 2}, {name: '已处理', value: 3}]
  * @param {Array} data.alarmRecords - 待处理的报警记录id数组
- * @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 {number} data.processingResult - 处理结果 [{name: '已通知', value: 1}, {name: '真实告警', value: 2}, {name: '测试', value: 3}, {name: '误报', value: 4}, {name: '处理完成', value: 5}, {name: '人工处理', value: 6}, {name: '设备自动复位', value: 7}, {name: '已推送至第三方', value: 8}, {name: '云呼通知失败', value: 9}, {name: '缺岗', value: 10}, {name: '云呼通知中', value: 11}, {name: '短信发送失败', value: 12}]
  * @param {string} data.fireDesc - 报警描述
- * @returns {Object} data - 返回对象
- * @returns {number} code - 返回码，0表示成功
- * @example <caption>请求范例</caption>
+ * @example
  * 当isAll为true时，传以下参数。代表处理条件内的所有报警记录
  * {
  *  isAll: true,
@@ -472,6 +621,11 @@ export function alarmCloudCall() {
  *  processingResult: 2,
  *  fireDesc: '报警描述'
  * }
+ * @returns {number} code - 返回码，0表示成功
+ * @example
+ * {
+ *   "code": 0
+ }
  */
 export function processingManyAlarm(data) {
   return requestShow({
@@ -481,34 +635,28 @@ 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} data - 返回对象
-   * @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 - 结束时间戳。
-   * @returns {number} code - 返回码，0表示成功。
-   * @returns {string} data - excel文件的下载相对链接。
-   * @returns {string} message - 描述。
-   */
+  * 报警记录导出excel
+  * @param {Object} data - 包含故障记录所需数据的请求体。
+  * @param {string} data.startTime - 开始时间戳。
+  * @param {string} data.endTime - 结束时间戳。
+  * @example
+  * {
+  "startTime": 1733016332000,
+  "endTime": 1735608332000
+  }
+  * @returns {number} code - 返回码，0表示成功。
+  * @returns {string} data - excel文件的下载相对链接。
+  * @returns {string} message - 描述。
+  * @example
+  * {
+  "code": 0,
+  "data": "/upload/报警记录1734109060666.xlsx",
+  "message": "导出成功"
+}
+*/
 export function exportAlarmRecord(data) {
   return requestShow({
     url: '/alarm-records/export-alarm-excel',
@@ -523,12 +671,47 @@ export function exportAlarmRecord(data) {
    * @param {Array} data.timestamps - 时间戳数组
    * @param {number} data.timestamps[].startTime - 开始时间戳
    * @param {number} data.timestamps[].endTime - 结束时间戳
+   * @example
+   * {
+   "timestamps": [
+     {
+       "startTime": 1733016332000,
+       "endTime": 1733102732000
+     },
+   ]
+   }
    * @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 - 报警计数
+   * @returns {string} data.date - 格式化后的时间字符串
+   * @returns {Array} data.counts - 报警类型计数数组
+   * @returns {string} data.counts.type - 报警类型取value值[{name:"设备告警",value:"device"},{name:"异常告警",value:"error"},{name:"设备故障",value:"trouble"},{name:"离线告警",value:"offline"}]
+   * @returns {number} data.counts.count - 报警计数
+   * @example
+   * {
+   "code": 0,
+   "data": [
+     {
+       "date": "2021-01-01 00:00:00", // 按照每个endTime的日期来进行格式化
+       "counts": [
+         {
+           "type": "device",
+           "count": 0
+         },
+         {
+           "type": "error",
+           "count": 0
+         },
+         {
+           "type": "trouble",
+           "count": 0
+         },
+         {
+           "type": "offline",
+           "count": 0
+         }
+       ]
+     },
+   ]}
    */
 export function getMoreAlarmCount(data) {
   return requestShow({
@@ -548,8 +731,6 @@ export default {
   getAlarmCount,
   getAlarmTotalCount,
   getMoreAlarmCount,
-  cloudCall,
-  alarmCloudCall,
   processingManyAlarm,
   exportAlarmRecord
 }

package/api/appRouter.js

@@ -22,7 +22,7 @@ import { requestShow } from '../utils'
  * @property {string} routes.icon - 子菜单的图标
  * @property {string} routes.name - 子菜单的名称
  * @property {string} routes.identifier - 子菜单的唯一标识
- * @property {string} routes.type - 子菜单的类型,取value值[{key:'分组菜单',value:'group'},{key:'页面菜单',value:'view'}]
+ * @property {string} routes.type - 子菜单的类型,取value值[{name:'分组菜单',value:'group'},{name:'页面菜单',value:'view'}]
  * @example
  * {
     "_id": "638ec3f7ed786520c52a44a8",

package/api/application.js

@@ -3,6 +3,7 @@ import { requestShow } from '../utils'
  * @file 应用信息api
  * @module 应用信息接口
  * @category 系统设置
+ * @categoryOrder 1
  */
 
 /**
@@ -11,7 +12,7 @@ import { requestShow } from '../utils'
  * @property {string} name - 应用信息名称
  * @property {string} icon - 应用图标
  * @property {string} color - 图标颜色
- * @property {number} type - 应用类型，取value值[{key: '本地应用', value: 0}, {key: '平台应用', value: 1}]
+ * @property {number} type - 应用类型，取value值[{name: '本地应用', value: 0}, {name: '平台应用', value: 1}]
  * @property {string} url - 应用路径
  * @example
  * {