nayota-show-sdk 0.0.2 → 0.0.3

package/api/alarmProgress.js

@@ -1,6 +1,6 @@
 /**
  * @file 报警进度接口
- * @module requestShow.alarmProgress  
+ * @module 报警进度接口
  * @memberof requestShow
  */
 import { requestShow } from '../utils'

package/api/alarmRecord.js

@@ -1,6 +1,6 @@
 /**
  * @file 报警记录api
- * @module requestShow.alarmRecord  
+ * @module 报警记录接口
  * @memberof requestShow
  */
 import { requestShow } from '../utils'
@@ -9,7 +9,7 @@ import { requestShow } from '../utils'
 /**
  * 获取列表
  * @param {*} query 
- *  @param {number} query.page - 页码
+ * @param {number} query.page - 页码
  * @param {number} query.limit - 每页数量
  * @param {string} query.label - 模糊查询关键字
  * @param {string} query.search - 模糊查询内容
@@ -136,16 +136,35 @@ 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 {Array} data.query.range - 查询的时间范围[开始毫秒时间戳，结束毫秒时间戳]
+ * @param {number} data.query.processingState - 查询的告警的处理状态（1：待处理，2：处理中，3：已处理）
  * @param {Array} data.alarmRecords - 待处理的报警记录id数组
- * @param {number} data.mainType - 告警的主要类型（1：设备告警，2：异常告警，3：设备故障，4：离线告警）
- * @param {number} data.processingResult - 处理结果（9：云呼通知失败，10：缺岗，12：短信发送失败，1：已通知，11：云呼通知中，2：真实火灾，3：测试，4：误报，5：真实预警，6：人工处理，7：设备自动复位，8：已推送至第三方）
- * @param {number} data.fireReason fireReason 火灾原因 误报原因
- * @param {string} data.fireDesc fireDesc 报警描述
- * @param {string} data.handle_user_name 现场处置人员姓名
- * @param {number} data.fault_content 处理情况（设备异常）
- * @param {string} data.reportperson_name 处理人员姓名（设备异常）
+ * @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({

package/api/departs.js

@@ -1,7 +1,7 @@
 import { requestShow } from '../utils'
 /**
  * @file 层级api
- * @module departs
+ * @module 层级接口
  */
 /**
  * 

package/api/product.js

@@ -1,6 +1,6 @@
 /**
  * @file 产品管理api
- * @module requestShow.product  
+ * @module 产品管理接口
  * @memberof requestShow
  */
 import { requestShow as request } from '../utils'

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.2",
+  "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"
   }
-}
+}