nayota-show-sdk 1.3.0 → 1.3.2

package/api/area.js

@@ -24,6 +24,7 @@ import { requestShow } from '../utils'
  * @property {Array} statisticsComponent - 统计组件名称数组
  * @property {Object} statisticsJson - 统计组件自定义json
  * @property {string} areaClass - 区域类型id
+ * @property {string} managerName - 管理人姓名
  * @example
  * {
     "_id": "67073bfe463d6e00099becdd",
@@ -34,6 +35,7 @@ import { requestShow } from '../utils'
     "opacity": 1,
     "type": "办公区",
     "areaClass": "67073bfe463d6e00099becdd",
+    "managerName": "张三",
     "bounds": [
         [
             116.404,

package/api/reservation.js

@@ -0,0 +1,207 @@
+import { requestShow } from '../utils'
+/**
+ * @file 预约记录api
+ * @module 预约记录接口
+ * @category 区域管理
+ * @import
+ * import { reservation } from 'nayota-show-sdk'
+ * const { list, create, updateOne, deleteOne, deleteMany, getOne, getReservationsByDepart } = reservation
+ * list({ page: 1, limit: 50 })
+ */
+
+
+/**
+ * @typedef {Object} Reservation - 预约记录
+ * @property {string} _id - 预约记录id
+ * @property {string} reserverName - 预约人名称
+ * @property {Date} startTime - 开始时间
+ * @property {Date} endTime - 结束时间
+ * @property {string} area - 空间（关联到Area模型）
+ * @property {string} depart - 层级（关联到Depart模型）
+ * @property {string} remark - 备注
+ * @property {string} approver - 审批人
+ * @property {Date} approveTime - 审批时间
+ * @property {number} approveStatus - 审批状态（0-待审批，1-已批准，2-已拒绝）
+ * @property {string} creator - 创建者
+ * @example
+ * {
+    "_id": "67073bfe463d6e00099becee",
+    "reserverName": "张三",
+    "startTime": "2025-03-07T08:00:00.000Z",
+    "endTime": "2025-03-07T10:00:00.000Z",
+    "area": "67073bfe463d6e00099becdd",
+    "depart": "667d2ecc52d21700095b58b4",
+    "remark": "项目讨论会议",
+    "approver": "李四",
+    "approveTime": "2025-03-06T10:00:00.000Z",
+    "approveStatus": 1,
+    "creator": "667d2ecc52d21700095b58b5",
+    "createdAt": "2025-03-06T09:00:00.000Z",
+    "updatedAt": "2025-03-06T10:00:00.000Z"
+ }
+ */
+
+
+/**
+ * 获取预约记录列表
+ * @param {Object} query - 请求对象
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @param {string} [query.area] - 按空间筛选
+ * @param {string} [query.depart] - 按层级筛选
+ * @param {number} [query.approveStatus] - 按审批状态筛选
+ * @param {string} [query.startDate] - 开始日期筛选
+ * @param {string} [query.endDate] - 结束日期筛选
+ * @example
+ * {
+ *    "page": 1,
+ *    "limit": 10,
+ *    "area": "67073bfe463d6e00099becdd",
+ *    "approveStatus": 1
+ * }
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 页面总数
+ * @returns {Array} rows - 页面数组见表结构reservation定义
+ * @example
+ * 
+ * {
+    "code": 0,
+    "total": 1,
+    "rows": [见表结构reservation定义]
+ }
+ */
+export function list(query) {
+  return requestShow({
+    url: '/reservations',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增预约记录
+ * @param {Object} data - 包含预约记录的请求体 属性见表结构reservation定义。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据 见表结构reservation定义
+ */
+export function create(data) {
+  return requestShow({
+    url: '/reservations',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取预约记录
+ * @param {string} id - 预约记录id
+ * @returns {number} code - 返回码，0表示成功。
+ * @returns {Object} data - 预约记录对象 见表结构reservation定义
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/reservations/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 修改预约记录
+ * @param {Object} data - 包含预约记录的请求体 属性见表结构reservation定义。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据 见表结构reservation定义
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/reservations/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除预约记录
+ * @param {string} id - 删除的预约记录id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据 见表结构reservation定义
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/reservations/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除预约记录
+ * @param {Array} ids - 删除的预约记录ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/reservations',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+
+/**
+ * 查询当前时间下特定层级的预约记录及关联设备
+ * @param {Object} query - 查询选项
+ * @param {string} query.depart - 层级ID
+ * @returns {Object} result - 返回结果
+ * @returns {number} result.code - 返回码，0表示成功
+ * @returns {Array} result.rows - 预约记录数组，每个记录包含关联设备
+ * @example
+ * // 请求示例
+ * {
+ *   "depart": "667d2ecc52d21700095b58b4"
+ * }
+ * 
+ * // 返回示例
+ * {
+ *   "code": 0,
+ *   "rows": [
+ *     {
+ *       // 预约记录信息，见表结构reservation定义
+ *       "_id": "67073bfe463d6e00099becee",
+ *       "reserverName": "张三",
+ *       "startTime": "2025-03-07T08:00:00.000Z",
+ *       "endTime": "2025-03-07T10:00:00.000Z",
+ *       "area": "67073bfe463d6e00099becdd",
+ *       "depart": "667d2ecc52d21700095b58b4",
+ *       "remark": "项目讨论会议",
+ *       "approveStatus": 1,
+ *       "creator": "667d2ecc52d21700095b58b5",
+ *       // 关联设备列表
+ *       "devices": [
+ *         {
+ *           "_id": "67073c1e463d6e00099becef",
+ *           "name": "会议室投影仪",
+ *           "area": "67073bfe463d6e00099becdd",
+ *           "status": 1
+ *           // 其他设备属性
+ *         }
+ *       ]
+ *     }
+ *   ]
+ * }
+ */
+export function getReservationsByDepart(query) {
+  return requestShow({
+    url: `/reservations/current/${query.depart}`,
+    method: 'get',
+    params: query
+  })
+}
+
+export default {
+  list,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany,
+  getOne,
+  getReservationsByDepart
+}

package/index.js

@@ -27,6 +27,7 @@ import inspectionTaskSub from './api/inspectionTaskSub'
 import product from './api/product'
 import area from './api/area'
 import areaClass from './api/areaClass'
+import reservation from './api/reservation'
 
 const api = {
   alarmRecord,
@@ -54,7 +55,8 @@ const api = {
   inspectionTaskSub,
   product,
   area,
-  areaClass
+  areaClass,
+  reservation
 }
 
 export default {

package/package.json

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