nayota-show-sdk 1.3.109 → 1.3.111

package/README.md

@@ -23,4 +23,26 @@ import { alarmRecord } from 'nayota-show-sdk'
 const { list, updateOne, create, delete } = alarmRecord
 // 正常调用
 list({ page:1, limit:50 })
-```
+```
+
+### 3.2 消防巡检合规接口
+```javascript
+// 检查模板
+NayotaSdk.inspectionCheckTemplates.list({ page: 1, limit: 20 })
+NayotaSdk.inspectionCheckTemplates.options()
+NayotaSdk.inspectionCheckTemplates.create(data)
+NayotaSdk.inspectionCheckTemplates.updateOne({ _id, ...data })
+NayotaSdk.inspectionCheckTemplates.deleteOne(_id)
+NayotaSdk.inspectionCheckTemplates.seedBuiltins()
+
+// 检查项
+NayotaSdk.inspectionCheckTemplates.listItems(templateId)
+NayotaSdk.inspectionCheckTemplates.createItem(templateId, data)
+NayotaSdk.inspectionCheckTemplates.sortItems(templateId, sortData)
+NayotaSdk.inspectionCheckItems.updateOne({ _id, ...data })
+NayotaSdk.inspectionCheckItems.deleteOne(_id)
+
+// 点位执行配置与巡检提交
+NayotaSdk.inspectionPoints.checkRuntime(pointId)
+NayotaSdk.inspectionTaskSub.submitCompliance(data)
+```

package/api/inspectionCheckItems.js

@@ -0,0 +1,39 @@
+import { requestShow } from '../utils'
+
+/**
+ * @file 巡检检查项api
+ * @module 巡检检查项接口
+ * @category 巡更管理
+ */
+
+/**
+ * 修改检查项
+ * @param {Object} data - 检查项数据，需包含 _id 或 id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 修改后的检查项
+ */
+export function updateOne(data) {
+  const id = data._id || data.id
+  return requestShow({
+    url: `/inspection-check-items/${id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除检查项
+ * @param {string} id - 检查项id
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/inspection-check-items/${id}`,
+    method: 'delete'
+  })
+}
+
+export default {
+  updateOne,
+  deleteOne
+}

package/api/inspectionCheckItems.test.js

@@ -0,0 +1,38 @@
+jest.mock('../utils', () => ({
+  requestShow: jest.fn()
+}))
+
+const { requestShow } = require('../utils')
+const inspectionCheckItems = require('./inspectionCheckItems').default
+const sdk = require('../index').default
+
+describe('inspectionCheckItems api', () => {
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('updates an inspection check item', () => {
+    const data = { _id: 'item-1', itemName: '消防栓外观检查' }
+
+    inspectionCheckItems.updateOne(data)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-items/item-1',
+      method: 'put',
+      data
+    })
+  })
+
+  test('deletes an inspection check item', () => {
+    inspectionCheckItems.deleteOne('item-1')
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-items/item-1',
+      method: 'delete'
+    })
+  })
+
+  test('exports module from sdk root', () => {
+    expect(sdk.inspectionCheckItems).toBe(inspectionCheckItems)
+  })
+})

package/api/inspectionCheckTemplates.js

@@ -0,0 +1,158 @@
+import { requestShow } from '../utils'
+
+/**
+ * @file 巡检检查模板api
+ * @module 巡检检查模板接口
+ * @category 巡更管理
+ */
+
+/**
+ * 获取检查模板列表
+ * @param {Object} query - 请求对象
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - { total, rows }
+ */
+export function list(query) {
+  return requestShow({
+    url: '/inspection-check-templates',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 获取启用检查模板下拉列表
+ * @param {Object} query - 请求对象
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Array} data - 模板下拉数组
+ */
+export function options(query) {
+  return requestShow({
+    url: '/inspection-check-templates/options',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增检查模板
+ * @param {Object} data - 检查模板数据
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 新增后的检查模板
+ */
+export function create(data) {
+  return requestShow({
+    url: '/inspection-check-templates',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取检查模板详情
+ * @param {string} id - 检查模板id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 检查模板详情
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/inspection-check-templates/${id}`,
+    method: 'get'
+  })
+}
+
+/**
+ * 修改检查模板
+ * @param {Object} data - 检查模板数据，需包含 _id 或 id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 修改后的检查模板
+ */
+export function updateOne(data) {
+  const id = data._id || data.id
+  return requestShow({
+    url: `/inspection-check-templates/${id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除检查模板
+ * @param {string} id - 检查模板id
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/inspection-check-templates/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 初始化内置检查模板
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 初始化结果
+ */
+export function seedBuiltins() {
+  return requestShow({
+    url: '/inspection-check-templates/seed-builtins',
+    method: 'post'
+  })
+}
+
+/**
+ * 获取模板下检查项列表
+ * @param {string} templateId - 检查模板id
+ * @param {Object} query - 请求对象
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Array} data - 检查项列表
+ */
+export function listItems(templateId, query) {
+  return requestShow({
+    url: `/inspection-check-templates/${templateId}/items`,
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增模板检查项
+ * @param {string} templateId - 检查模板id
+ * @param {Object} data - 检查项数据
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 新增后的检查项
+ */
+export function createItem(templateId, data) {
+  return requestShow({
+    url: `/inspection-check-templates/${templateId}/items`,
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 调整模板检查项排序
+ * @param {string} templateId - 检查模板id
+ * @param {Object|Array} data - 排序数据
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function sortItems(templateId, data) {
+  return requestShow({
+    url: `/inspection-check-templates/${templateId}/items/sort`,
+    method: 'put',
+    data
+  })
+}
+
+export default {
+  list,
+  options,
+  create,
+  getOne,
+  updateOne,
+  deleteOne,
+  seedBuiltins,
+  listItems,
+  createItem,
+  sortItems
+}

package/api/inspectionCheckTemplates.test.js

@@ -0,0 +1,128 @@
+jest.mock('../utils', () => ({
+  requestShow: jest.fn()
+}))
+
+const { requestShow } = require('../utils')
+const inspectionCheckTemplates = require('./inspectionCheckTemplates').default
+const sdk = require('../index').default
+
+describe('inspectionCheckTemplates api', () => {
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('lists inspection check templates', () => {
+    const query = { page: 1, limit: 20, keyword: 'fire' }
+
+    inspectionCheckTemplates.list(query)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates',
+      method: 'get',
+      params: query
+    })
+  })
+
+  test('gets inspection check template options', () => {
+    const query = { status: true }
+
+    inspectionCheckTemplates.options(query)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/options',
+      method: 'get',
+      params: query
+    })
+  })
+
+  test('creates an inspection check template', () => {
+    const data = { name: '消防巡检模板' }
+
+    inspectionCheckTemplates.create(data)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates',
+      method: 'post',
+      data
+    })
+  })
+
+  test('gets one inspection check template', () => {
+    inspectionCheckTemplates.getOne('template-1')
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/template-1',
+      method: 'get'
+    })
+  })
+
+  test('updates an inspection check template', () => {
+    const data = { _id: 'template-1', name: '更新模板' }
+
+    inspectionCheckTemplates.updateOne(data)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/template-1',
+      method: 'put',
+      data
+    })
+  })
+
+  test('deletes an inspection check template', () => {
+    inspectionCheckTemplates.deleteOne('template-1')
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/template-1',
+      method: 'delete'
+    })
+  })
+
+  test('seeds built-in templates', () => {
+    inspectionCheckTemplates.seedBuiltins()
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/seed-builtins',
+      method: 'post'
+    })
+  })
+
+  test('lists template items', () => {
+    const query = { status: true }
+
+    inspectionCheckTemplates.listItems('template-1', query)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/template-1/items',
+      method: 'get',
+      params: query
+    })
+  })
+
+  test('creates a template item', () => {
+    const data = { itemName: '灭火器压力检查' }
+
+    inspectionCheckTemplates.createItem('template-1', data)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/template-1/items',
+      method: 'post',
+      data
+    })
+  })
+
+  test('sorts template items', () => {
+    const data = [{ id: 'item-1', sort: 1 }]
+
+    inspectionCheckTemplates.sortItems('template-1', data)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-check-templates/template-1/items/sort',
+      method: 'put',
+      data
+    })
+  })
+
+  test('exports module from sdk root', () => {
+    expect(sdk.inspectionCheckTemplates).toBe(inspectionCheckTemplates)
+  })
+})

package/api/inspectionCompliance.test.js

@@ -0,0 +1,38 @@
+jest.mock('../utils', () => ({
+  requestShow: jest.fn()
+}))
+
+const { requestShow } = require('../utils')
+const inspectionPoints = require('./inspectionPoints').default
+const inspectionTaskSub = require('./inspectionTaskSub').default
+
+describe('inspection compliance api', () => {
+  afterEach(() => {
+    jest.clearAllMocks()
+  })
+
+  test('gets point check runtime', () => {
+    inspectionPoints.checkRuntime('point-1')
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-points/point-1/check-runtime',
+      method: 'get'
+    })
+  })
+
+  test('submits compliance result', () => {
+    const data = {
+      taskId: 'task-1',
+      pointId: 'point-1',
+      itemResults: [{ itemId: 'item-1', result: 'normal' }]
+    }
+
+    inspectionTaskSub.submitCompliance(data)
+
+    expect(requestShow).toHaveBeenCalledWith({
+      url: '/inspection-task-subs/submit-compliance',
+      method: 'post',
+      data
+    })
+  })
+})

package/api/inspectionPoints.js

@@ -88,6 +88,19 @@ export function getOne(id) {
   })
 }
 
+/**
+ * 获取点位巡检执行配置
+ * @param {string} id - 点位id
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 点位、检查模板、检查项和证据规则
+ */
+export function checkRuntime(id) {
+  return requestShow({
+    url: `/inspection-points/${id}/check-runtime`,
+    method: 'get'
+  })
+}
+
 /**
  * 修改点位
  * @param {Object} data - 包含点位的请求体 属性见表结构inspectionPoint定义。
@@ -134,5 +147,6 @@ export default {
   updateOne,
   deleteOne,
   deleteMany,
-  getOne
+  getOne,
+  checkRuntime
 }

package/api/inspectionTaskSub.js

@@ -96,6 +96,24 @@ export function create(data) {
   })
 }
 
+/**
+ * 提交巡检合规记录
+ * @param {Object} data - 巡检提交数据
+ * @param {string} data.taskId - 巡检任务id
+ * @param {string} data.pointId - 点位id
+ * @param {Array} data.itemResults - 检查项结果快照
+ * @param {Array} [data.photos] - 现场照片
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 保存后的巡检子任务/记录
+ */
+export function submitCompliance(data) {
+  return requestShow({
+    url: '/inspection-task-subs/submit-compliance',
+    method: 'post',
+    data
+  })
+}
+
 /**
  * 获取巡查任务子表
  * @param {string} id - 巡查任务子表id
@@ -182,6 +200,7 @@ export default {
   summary,
   offline,
   create,
+  submitCompliance,
   updateOne,
   deleteOne,
   deleteMany,

package/index.js

@@ -25,6 +25,8 @@ import inspectionPoints from "./api/inspectionPoints";
 import patrolPoints from "./api/patrolPoints";
 import inspectionTask from "./api/inspectionTask";
 import inspectionTaskSub from "./api/inspectionTaskSub";
+import inspectionCheckTemplates from "./api/inspectionCheckTemplates";
+import inspectionCheckItems from "./api/inspectionCheckItems";
 import inspectionTeams from "./api/inspectionTeams";
 import product from "./api/product";
 import area from "./api/area";
@@ -68,6 +70,8 @@ const api = {
   patrolPoints,
   inspectionTask,
   inspectionTaskSub,
+  inspectionCheckTemplates,
+  inspectionCheckItems,
   inspectionTeams,
   product,
   area,

package/index.test.js

@@ -1,38 +1,14 @@
-let modules
-beforeAll(() => {
-  jest.mock('./__mocks__/requireContext')
-
-  modules = require('./index.js')
-})
-
-// Test the modules object
-describe('modules', () => {
-  test('should have the correct structure', () => {
-    expect(modules).toBeDefined()
-    expect(typeof modules).toBe('object')
-    expect(Object.keys(modules)).toHaveLength(17) // Assuming there is only one module in the littleTool directory
-
-    // Test the structure of the module
-    // const module = modules['api'] // Assuming the module name is 'api'
-    // expect(module).toBeDefined()
-    // expect(typeof module).toBe('object')
-    // expect(Object.keys(module)).toHaveLength(13) // Assuming there are 13 sub-modules in the api directory
-
-    // // Test the structure of each sub-module
-    // expect(module['alarms']).toBeDefined()
-    // expect(module['checkReduces']).toBeDefined()
-    // expect(module['user']).toBeDefined()
-    // expect(module['httpDrives']).toBeDefined()
-    // expect(module['hardwares']).toBeDefined()
-    // expect(module['checks']).toBeDefined()
-    // expect(module['cloudHardwares']).toBeDefined()
-    // expect(module['loraSlaves']).toBeDefined()
-    // expect(module['lorawanDevices']).toBeDefined()
-    // expect(module['nbiotDrives']).toBeDefined()
-    // expect(module['nbm2mDevices']).toBeDefined()
-    // expect(module['netDrives']).toBeDefined()
-    // expect(module['netMqttDevices']).toBeDefined()
-    // // 添加alarms list请求的测试
-    // expect(module['alarms']['list']).toBeDefined()
+const sdk = require('./index.js').default
+
+describe('sdk root export', () => {
+  test('exports config, event hook and api modules', () => {
+    expect(sdk).toBeDefined()
+    expect(typeof sdk).toBe('object')
+    expect(typeof sdk.config).toBe('function')
+    expect(typeof sdk.on).toBe('function')
+    expect(sdk.inspectionPoints).toBeDefined()
+    expect(sdk.inspectionTaskSub).toBeDefined()
+    expect(sdk.inspectionCheckTemplates).toBeDefined()
+    expect(sdk.inspectionCheckItems).toBeDefined()
   })
 })

package/package.json

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

package/utils/iot-module-specs.js

@@ -1101,6 +1101,22 @@ function createDeviceClassOperations() {
     }
   }
 
+  operations.onlineRate = {
+    toRequest(query = {}) {
+      return {
+        url: '/device-classes/online-rate',
+        method: 'get',
+        params: query
+      }
+    },
+    fromResponse(response) {
+      const payload = response && response.data && response.status ? response.data : response
+      return payload && payload.code !== undefined
+        ? payload
+        : { code: 0, data: payload?.data !== undefined ? payload.data : payload }
+    }
+  }
+
   return operations
 }
 

package/utils/iot-module-specs.test.js

@@ -51,6 +51,34 @@ describe('iotModuleSpecs deviceClass UI compatibility', () => {
     expect(request.data.metadata.bms.deviceUI).toBe('legacy-device-ui-2')
   })
 
+  test('maps onlineRate to the iot legacy-compatible device-classes endpoint', () => {
+    const request = deviceClass.onlineRate.toRequest({ year: 2026, month: 7 })
+
+    expect(request).toEqual({
+      url: '/device-classes/online-rate',
+      method: 'get',
+      params: { year: 2026, month: 7 }
+    })
+
+    expect(
+      deviceClass.onlineRate.fromResponse({
+        code: 0,
+        data: {
+          year: 2026,
+          month: 7,
+          summary: { onlineRate: 1 }
+        }
+      })
+    ).toEqual({
+      code: 0,
+      data: {
+        year: 2026,
+        month: 7,
+        summary: { onlineRate: 1 }
+      }
+    })
+  })
+
   test('expands digital twin type ui relation back to legacy uis', () => {
     const response = deviceClass.list.fromResponse({
       code: 0,