nayota-show-sdk 1.3.45 → 1.3.47

package/api/maintenancePlan.js

@@ -0,0 +1,132 @@
+import { requestShow } from '../utils'
+
+/**
+ * @file 维保计划api
+ * @module 维保计划接口
+ * @category 维保管理
+ * @import
+ * import { maintenancePlan } from 'nayota-show-sdk'
+ * const { list, create, getOne, updateOne, deleteOne, deleteMany } = maintenancePlan
+ * list({ page: 1, limit: 10 })
+ */
+
+/**
+ * @typedef {Object} MaintenancePlan - 维保计划
+ * @property {string} _id - 维保计划id
+ * @property {Array} devices - 关联设备
+ * @property {Date} startTime - 开始时间
+ * @property {Date} endTime - 结束时间
+ * @property {string} remark - 备注
+ * @property {string} creator - 创建者
+ * @property {Date} createdAt - 创建日期
+ * @property {Date} updatedAt - 更新日期
+ * @example
+ * {
+ *   "_id": "67498c0ea2bd800009fa8931",
+ *   "devices": [],
+ *   "startTime": "2024-11-29T02:07:02.042Z",
+ *   "endTime": "2024-11-29T12:07:02.042Z",
+ *   "remark": "定期维保",
+ *   "creator": "6678e31ff340dfdecd9e1a28",
+ *   "createdAt": "2024-11-29T02:07:02.042Z",
+ *   "updatedAt": "2024-11-29T02:07:02.042Z"
+ * }
+ */
+
+/**
+ * 获取维保计划列表
+ * @param {Object} query - 请求对象
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @param {string} query.keyword - 模糊查询关键字
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 总数
+ * @returns {Array} rows - 列表数据 见表结构MaintenancePlan定义
+ */
+export function list(query) {
+  return requestShow({
+    url: '/maintenance-plans',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增维保计划
+ * @param {Object} data - 请求体
+ * @param {Array} data.devices - 关联设备
+ * @param {Date} data.startTime - 开始时间
+ * @param {Date} data.endTime - 结束时间
+ * @param {string} [data.remark] - 备注
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 新增成功的数据
+ */
+export function create(data) {
+  return requestShow({
+    url: '/maintenance-plans',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取维保计划详情
+ * @param {string} id - 维保计划id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 详情对象
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/maintenance-plans/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 编辑维保计划
+ * @param {Object} data - 修改数据对象
+ * @param {string} data._id - 维保计划id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 修改后的数据
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/maintenance-plans/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除维保计划
+ * @param {string} id - id
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/maintenance-plans/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除维保计划
+ * @param {Array} ids - id数组
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/maintenance-plans',
+    method: 'delete',
+    data: ids
+  })
+}
+
+export default {
+  list,
+  create,
+  getOne,
+  updateOne,
+  deleteOne,
+  deleteMany
+}

package/api/patrolPoints.js

@@ -0,0 +1,131 @@
+import { requestShow } from '../utils'
+/**
+ * @file 巡查点位api
+ * @module 巡查点位接口
+ * @category 巡更管理
+ * @categoryOrder 7
+ */
+
+/**
+ * @typedef {Object} patrolPoint - 巡查点位
+ * @property {string} _id - 点位id.
+ * @property {string} name - 点位名称.
+ * @property {number} x - 坐标x
+ * @property {number} y - 坐标y
+ * @property {string} resourceType - 资源类型
+ * @property {string} resourceAddress - 资源地址
+ * @property {string} depart - 层级
+ * @property {boolean} isPanorama - 是否全景
+ * @property {string} remark - 备注
+ * @example
+ * [
+ *     {
+ *         "_id": "67073bfe463d6e00099becdd",
+ *         "name": "1号位置",
+ *         "x": 100,
+ *         "y": 200,
+ *         "resourceType": "image",
+ *         "resourceAddress": "/uploads/1.jpg",
+ *         "depart": "6678e31ff340dfdecd9e1a28",
+ *         "isPanorama": false,
+ *         "remark": "备注信息",
+ *         "createdAt": "2024-10-10T02:29:18.026Z",
+ *         "updatedAt": "2024-10-10T02:29:18.026Z",
+ *         "__v": 0
+ *     }
+ * ]
+ * 
+ */
+
+
+/**
+ * 获取巡查点位列表
+ * @param {Object} query - 请求对象
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 页面总数
+ * @returns {Array} rows - 页面数组见表结构patrolPoint定义
+ */
+export function list(query) {
+  return requestShow({
+    url: '/patrol-points',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增巡查点位
+ * @param {Object} data - 包含巡查点位的请求体 属性见表结构patrolPoint定义。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 见表结构patrolPoint定义
+ */
+export function create(data) {
+  return requestShow({
+    url: '/patrol-points',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取巡查点位
+ * @param {string} id - 巡查点位id
+ * @returns {number} code - 返回码，0表示成功。
+ * @returns {Object} data - 巡查点位对象 见表结构patrolPoint定义
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/patrol-points/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 修改巡查点位
+ * @param {Object} data - 包含巡查点位的请求体 属性见表结构patrolPoint定义。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 见表结构patrolPoint定义
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/patrol-points/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除巡查点位
+ * @param {string} id - 删除的巡查点位id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 见表结构patrolPoint定义
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/patrol-points/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除巡查点位
+ * @param {Array} ids - 删除的巡查点位ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/patrol-points',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany,
+  getOne
+}

package/index.js

@@ -22,6 +22,7 @@ import userDevice from "./api/userDevice";
 import video from "./api/video";
 import line from "./api/line";
 import inspectionPoints from "./api/inspectionPoints";
+import patrolPoints from "./api/patrolPoints";
 import inspectionTask from "./api/inspectionTask";
 import inspectionTaskSub from "./api/inspectionTaskSub";
 import product from "./api/product";
@@ -34,6 +35,7 @@ import sensor from "./api/sensor";
 import scadaProject from "./api/scadaProject";
 import energyCalculation from "./api/energyCalculation";
 import energyConsumption from "./api/energyConsumption";
+import maintenancePlan from "./api/maintenancePlan";
 const api = {
   alarmRecord,
   alarmProgress,
@@ -56,6 +58,7 @@ const api = {
   video,
   line,
   inspectionPoints,
+  patrolPoints,
   inspectionTask,
   inspectionTaskSub,
   product,
@@ -68,6 +71,7 @@ const api = {
   scadaProject,
   energyCalculation,
   energyConsumption,
+  maintenancePlan,
 };
 
 export default {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nayota-show-sdk",
-  "version": "1.3.45",
+  "version": "1.3.47",
   "description": "nayota-show-server rest-api",
   "type": "module",
   "main": "index.js",