nayota-show-sdk 1.3.47 → 1.3.49

package/api/maintenancePlan.js

@@ -13,7 +13,9 @@ import { requestShow } from '../utils'
 /**
  * @typedef {Object} MaintenancePlan - 维保计划
  * @property {string} _id - 维保计划id
- * @property {Array} devices - 关联设备
+ * @property {string} name - 计划名称
+ * @property {Array<string>} devices - 关联设备id数组
+ * @property {Array<string>} sensors - 关联传感器id数组
  * @property {Date} startTime - 开始时间
  * @property {Date} endTime - 结束时间
  * @property {string} remark - 备注
@@ -23,7 +25,9 @@ import { requestShow } from '../utils'
  * @example
  * {
  *   "_id": "67498c0ea2bd800009fa8931",
- *   "devices": [],
+ *   "name": "季度维保",
+ *   "devices": ["67498c0ea2bd800009fa8001"],
+ *   "sensors": ["67498c0ea2bd800009fa8002"],
  *   "startTime": "2024-11-29T02:07:02.042Z",
  *   "endTime": "2024-11-29T12:07:02.042Z",
  *   "remark": "定期维保",
@@ -36,9 +40,12 @@ import { requestShow } from '../utils'
 /**
  * 获取维保计划列表
  * @param {Object} query - 请求对象
- * @param {number} query.page - 页码
- * @param {number} query.limit - 每页数量
- * @param {string} query.keyword - 模糊查询关键字
+ * @param {number} [query.page] - 页码
+ * @param {number} [query.limit] - 每页数量
+ * @param {string} [query.label] - 模糊查询字段
+ * @param {string} [query.search] - 模糊查询值
+ * @param {string} [query.name] - 计划名称
+ * @param {string} [query.sort] - 排序字段
  * @returns {number} code - 返回码，0表示成功
  * @returns {number} total - 总数
  * @returns {Array} rows - 列表数据 见表结构MaintenancePlan定义
@@ -54,9 +61,11 @@ export function list(query) {
 /**
  * 新增维保计划
  * @param {Object} data - 请求体
- * @param {Array} data.devices - 关联设备
- * @param {Date} data.startTime - 开始时间
- * @param {Date} data.endTime - 结束时间
+ * @param {string} [data.name] - 计划名称
+ * @param {Array<string>} [data.devices] - 关联设备id数组，传入时至少 1 项
+ * @param {Array<string>} [data.sensors] - 关联传感器id数组
+ * @param {Date} [data.startTime] - 开始时间
+ * @param {Date} [data.endTime] - 结束时间，必须大于 startTime
  * @param {string} [data.remark] - 备注
  * @returns {number} code - 返回码，0表示成功
  * @returns {Object} data - 新增成功的数据
@@ -86,6 +95,12 @@ export function getOne(id) {
  * 编辑维保计划
  * @param {Object} data - 修改数据对象
  * @param {string} data._id - 维保计划id
+ * @param {string} [data.name] - 计划名称
+ * @param {Array<string>} [data.devices] - 关联设备id数组，传入时至少 1 项
+ * @param {Array<string>} [data.sensors] - 关联传感器id数组
+ * @param {Date} [data.startTime] - 开始时间
+ * @param {Date} [data.endTime] - 结束时间，必须大于 startTime
+ * @param {string} [data.remark] - 备注
  * @returns {number} code - 返回码，0表示成功
  * @returns {Object} data - 修改后的数据
  */

package/api/maintenanceRecord.js

@@ -0,0 +1,211 @@
+import { requestShow } from '../utils'
+
+/**
+ * @file 维保记录api
+ * @module 维保记录接口
+ * @category 维保管理
+ * @import
+ * import { maintenanceRecord } from 'nayota-show-sdk'
+ * const { list, postList, create, getOne, updateOne, deleteOne, deleteMany, batchProcessingMaintenance } = maintenanceRecord
+ * list({ page: 1, limit: 10 })
+ */
+
+/**
+ * @typedef {Object} MaintenanceRecord - 维保记录
+ * @property {string} _id - 维保记录id
+ * @property {number} mainType - 告警大类
+ * @property {string} subType - 告警小类
+ * @property {string|Object} device - 关联设备
+ * @property {string|Object} maintenancePlan - 关联维保计划
+ * @property {number} event_time - 发生时间时间戳
+ * @property {string} desc - 描述
+ * @property {number} number - 次数
+ * @property {number} processingState - 处理状态
+ * @property {number} processingResult - 处理结果
+ * @property {string} confirmPersonName - 处理人
+ * @property {number} processingTime - 处理时间时间戳
+ * @property {number} disposalDuration - 处置时长
+ * @property {number} noticeWay - 通知方式
+ * @property {string} creator - 创建者
+ * @property {string} recall - 唯一码
+ * @property {number} type - 类型
+ * @property {Date} createdAt - 创建时间
+ * @property {Date} updatedAt - 更新时间
+ * @example
+ * {
+ *   "_id": "67cfbf6d2b4b3f0009e4a001",
+ *   "mainType": 1,
+ *   "subType": "测试告警",
+ *   "device": "67cfbf6d2b4b3f0009e4a002",
+ *   "maintenancePlan": "67cfbf6d2b4b3f0009e4a004",
+ *   "event_time": 1773187200000,
+ *   "desc": "维保期间触发测试告警",
+ *   "number": 1,
+ *   "processingState": 3,
+ *   "processingResult": 3,
+ *   "disposalDuration": 0,
+ *   "noticeWay": 3,
+ *   "creator": "67cfbf6d2b4b3f0009e4a003",
+ *   "recall": "maintenance-test-001",
+ *   "type": 3,
+ *   "createdAt": "2026-03-11T00:00:00.000Z",
+ *   "updatedAt": "2026-03-11T00:00:00.000Z"
+ * }
+ */
+
+/**
+ * 获取维保记录列表
+ * @param {Object} query - 请求对象
+ * @param {number} [query.page] - 页码
+ * @param {number} [query.limit] - 每页数量
+ * @param {string} [query.label] - 模糊查询字段
+ * @param {string} [query.search] - 模糊查询值
+ * @param {string} [query.device] - 设备id
+ * @param {number} [query.mainType] - 告警大类
+ * @param {string} [query.subType] - 告警小类
+ * @param {string} [query.sort] - 排序字段
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 总数
+ * @returns {Array<MaintenanceRecord>} rows - 列表数据
+ */
+export function list(query) {
+  return requestShow({
+    url: '/maintenance-records',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * POST 方式查询维保记录列表
+ * @param {Object} data - 请求体
+ * @param {number} [data.page] - 页码
+ * @param {number} [data.limit] - 每页数量
+ * @param {string} [data.label] - 模糊查询字段
+ * @param {string} [data.search] - 模糊查询值
+ * @param {string} [data.device] - 设备id
+ * @param {number} [data.mainType] - 告警大类
+ * @param {string} [data.subType] - 告警小类
+ * @param {string} [data.sort] - 排序字段
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 总数
+ * @returns {Array<MaintenanceRecord>} rows - 列表数据
+ */
+export function postList(data) {
+  return requestShow({
+    url: '/maintenance-records/post-list',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 新增维保记录
+ * @param {Object} data - 请求体
+ * @param {number} [data.mainType] - 告警大类
+ * @param {string} [data.subType] - 告警小类
+ * @param {string} [data.device] - 关联设备id
+ * @param {string} [data.maintenancePlan] - 关联维保计划id
+ * @param {number} [data.event_time] - 发生时间时间戳
+ * @param {string} [data.desc] - 描述
+ * @param {number} [data.number] - 次数
+ * @param {number} [data.processingState] - 处理状态
+ * @param {number} [data.processingResult] - 处理结果
+ * @param {number} [data.disposalDuration] - 处置时长
+ * @param {number} [data.noticeWay] - 通知方式
+ * @param {string} [data.recall] - 唯一码
+ * @param {number} [data.type] - 类型
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {MaintenanceRecord} data - 新增成功的数据
+ */
+export function create(data) {
+  return requestShow({
+    url: '/maintenance-records',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取维保记录详情
+ * @param {string} id - 维保记录id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {MaintenanceRecord} data - 详情对象
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/maintenance-records/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 编辑维保记录
+ * @param {Object} data - 修改数据对象
+ * @param {string} data._id - 维保记录id
+ * @param {string} [data.maintenancePlan] - 关联维保计划id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {MaintenanceRecord} data - 修改后的数据
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/maintenance-records/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除维保记录
+ * @param {string} id - 维保记录id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {MaintenanceRecord} data - 删除的数据
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/maintenance-records/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除维保记录
+ * @param {Array<string>} ids - 维保记录id数组
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/maintenance-records',
+    method: 'delete',
+    data: ids
+  })
+}
+
+/**
+ * 批量处理维保记录
+ * @param {Object} data - 请求体
+ * @param {Array<string>} data.maintenanceRecords - 需要处理的维保记录id数组
+ * @param {number} data.processingResult - 处理结果
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {object} data - 处理结果
+ * @returns {number} data.matchedCount - 匹配条数
+ * @returns {number} data.modifiedCount - 修改条数
+ */
+export function batchProcessingMaintenance(data) {
+  return requestShow({
+    url: '/maintenance-records/processing-many-maintenance',
+    method: 'post',
+    data
+  })
+}
+
+export default {
+  list,
+  postList,
+  create,
+  getOne,
+  updateOne,
+  deleteOne,
+  deleteMany,
+  batchProcessingMaintenance
+}

package/api/sensorStatusConfig.js

@@ -0,0 +1,137 @@
+import { requestShow } from '../utils'
+
+/**
+ * @file 传感器维保区间api
+ * @module 传感器维保区间接口
+ * @category 维保管理
+ * @import
+ * import { sensorStatusConfig } from 'nayota-show-sdk'
+ * const { list, create, getOne, updateOne, deleteOne, deleteMany } = sensorStatusConfig
+ * list({ page: 1, limit: 10 })
+ */
+
+/**
+ * @typedef {Object} SensorStatusConfig - 传感器维保区间
+ * @property {string} _id - 配置id
+ * @property {string} type - 传感器类型
+ * @property {Array<string>} range - 维保状态区间
+ * @property {string} remark - 备注
+ * @property {string} creator - 创建者
+ * @property {Date} createdAt - 创建时间
+ * @property {Date} updatedAt - 更新时间
+ * @example
+ * {
+ *   "_id": "66f000000000000000000001",
+ *   "type": "温度",
+ *   "range": ["正常", "预警", "报警"],
+ *   "remark": "默认区间",
+ *   "creator": "66f000000000000000000002",
+ *   "createdAt": "2026-03-11T00:00:00.000Z",
+ *   "updatedAt": "2026-03-11T00:00:00.000Z"
+ * }
+ */
+
+/**
+ * 获取传感器维保区间列表
+ * @param {Object} query - 请求对象
+ * @param {number} [query.page] - 页码
+ * @param {number} [query.limit] - 每页数量
+ * @param {string} [query.label] - 模糊查询字段
+ * @param {string} [query.search] - 模糊查询值
+ * @param {string} [query.type] - 传感器类型
+ * @param {string} [query.remark] - 备注
+ * @param {string} [query.sort] - 排序字段
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 总数
+ * @returns {Array<SensorStatusConfig>} rows - 列表数据
+ */
+export function list(query) {
+  return requestShow({
+    url: '/sensor-status-configs',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增传感器维保区间
+ * @param {Object} data - 请求体
+ * @param {string} data.type - 传感器类型
+ * @param {Array<string>} data.range - 维保状态区间，至少 1 项
+ * @param {string} [data.remark] - 备注，允许空字符串
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {SensorStatusConfig} data - 新增成功的数据
+ */
+export function create(data) {
+  return requestShow({
+    url: '/sensor-status-configs',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取传感器维保区间详情
+ * @param {string} id - 配置id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {SensorStatusConfig} data - 详情对象
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/sensor-status-configs/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 编辑传感器维保区间
+ * @param {Object} data - 修改数据对象
+ * @param {string} data._id - 配置id
+ * @param {string} [data.type] - 传感器类型
+ * @param {Array<string>} [data.range] - 维保状态区间，至少 1 项
+ * @param {string} [data.remark] - 备注，允许空字符串
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {SensorStatusConfig} data - 修改后的数据
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/sensor-status-configs/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除传感器维保区间
+ * @param {string} id - 配置id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {SensorStatusConfig} data - 删除的数据
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/sensor-status-configs/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除传感器维保区间
+ * @param {Array<string>} ids - 配置id数组
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/sensor-status-configs',
+    method: 'delete',
+    data: ids
+  })
+}
+
+export default {
+  list,
+  create,
+  getOne,
+  updateOne,
+  deleteOne,
+  deleteMany
+}

package/index.js

@@ -36,6 +36,8 @@ import scadaProject from "./api/scadaProject";
 import energyCalculation from "./api/energyCalculation";
 import energyConsumption from "./api/energyConsumption";
 import maintenancePlan from "./api/maintenancePlan";
+import maintenanceRecord from "./api/maintenanceRecord";
+import sensorStatusConfig from "./api/sensorStatusConfig";
 const api = {
   alarmRecord,
   alarmProgress,
@@ -72,6 +74,8 @@ const api = {
   energyCalculation,
   energyConsumption,
   maintenancePlan,
+  maintenanceRecord,
+  sensorStatusConfig,
 };
 
 export default {

package/package.json

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