nayota-show-sdk 1.2.2 → 1.2.4

package/api/area.js

@@ -0,0 +1,159 @@
+import { requestShow } from '../utils'
+/**
+ * @file 区域设置api
+ * @module 区域设置接口
+ * @category 区域设置
+ */
+
+
+/**
+ * @typedef {Object} Area - 区域
+ * @property {string} _id - 区域id
+ * @property {string} name - 区域名称
+ * @property {string} imageUrl - 区域图片
+ * @property {string} depart - 可视化层级的id
+ * @property {boolean} visible - 是否显示
+ * @property {number} opacity - 透明度
+ * @property {string} type - 区域类型
+ * @property {Array} bounds - 区域边界点
+ * @property {Array} statisticsComponent - 统计组件名称数组
+ * @property {Object} statisticsJson - 统计组件自定义json
+ * @example
+ * {
+    "_id": "67073bfe463d6e00099becdd",
+    "name": "办公区",
+    "imageUrl": "https://images.pexels.com/photos/67473/pexels-photo-67473.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=750&w=1260",
+    "depart": "667d2ecc52d21700095b58b4",
+    "visible": true,
+    "opacity": 1,
+    "type": "办公区",
+    "bounds": [
+        [
+            116.404,
+            39.915
+        ],
+        [
+            116.404,
+            39.915
+        ],
+        [
+            116.404,
+            39.915
+        ],
+        [
+            116.404,
+            39.915
+        ],
+        [
+            116.404,
+            39.915
+        ]
+    ]
+ }
+ */
+
+
+/**
+ * 获取区域列表
+ * @param {Object} query - 请求对象
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @example
+ * {
+ *    "page": 1,
+ *    "limit": 10
+ * }
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 页面总数
+ * @returns {Array} rows - 页面数组见表结构area定义
+ * @example
+ * 
+ * {
+    "code": 0,
+    "total": 1,
+    "rows": [见表结构area定义]
+ }
+ */
+export function list(query) {
+  return requestShow({
+    url: '/areas',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增区域
+ * @param {Object} data - 包含区域的请求体 属性见表结构area定义。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 见表结构area定义
+ */
+export function create(data) {
+  return requestShow({
+    url: '/areas',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取区域
+ * @param {string} id - 区域id
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 区域对象 见表结构area定义
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/areas/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 修改区域
+ * @param {Object} data - 包含区域的请求体 属性见表结构area定义。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 见表结构area定义
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/areas/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除区域
+ * @param {string} id - 删除的区域id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 见表结构area定义
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/areas/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除区域
+ * @param {Array} ids - 删除的区域ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/areas',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany,
+  getOne
+}
+

package/api/line.js

@@ -141,7 +141,6 @@ export function deleteOne(id) {
 
 /**
  * 批量删除路线
- * @customDesc 这是接口描述
  * @param {Array} ids - 删除的路线ids。
  * @returns {number} code - 返回码，0表示成功
  */

package/index.js

@@ -25,6 +25,8 @@ import inspectionPoints from './api/inspectionPoints'
 import inspectionTask from './api/inspectionTask'
 import inspectionTaskSub from './api/inspectionTaskSub'
 import product from './api/product'
+import area from './api/area'
+
 const api = {
   alarmRecord,
   alarmProgress,
@@ -49,7 +51,8 @@ const api = {
   inspectionPoints,
   inspectionTask,
   inspectionTaskSub,
-  product
+  product,
+  area
 }
 
 export default {

package/package.json

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