nayota-show-sdk 1.2.1 → 1.2.3

package/.babelrc

@@ -1,12 +1,12 @@
-{
-    "presets": [
-        [
-            "@babel/preset-env",
-            {
-                "targets": {
-                    "node": "current"
-                }
-            }
-        ]
-    ]
+{
+    "presets": [
+        [
+            "@babel/preset-env",
+            {
+                "targets": {
+                    "node": "current"
+                }
+            }
+        ]
+    ]
 }

package/README.md

@@ -1,20 +1,26 @@
-# Nayota开放SDK文档
-
-
-## 1. SDK简介
-nayota开放SDK是为了方便开发者快速接入nayota平台而提供的一套开发工具包。SDK提供了一系列的API接口，开发者可以通过调用这些接口实现与nayota平台的交互。
-
-## 2. SDK npm 安装
-```shell
-npm install nayota-show-sdk
-``` 
-
-## 3. SDK使用
-### 3.1 初始化SDK
-```javascript
-import NayotaSdk from 'nayota-show-sdk'
-NayotaSdk.config({
-  authTokenName: 'Admin-Token', // api接口存储的token到cookie的key名称
-  showServer: 'http://localhost:8080/api', // noyota-impossible-pro配置服务地址
-})
+# Nayota开放SDK文档
+
+
+## 1. SDK简介
+Nayota开放SDK是为了方便开发者快速接入Nayota平台而提供的一套开发工具包。SDK提供了一系列的API接口，开发者可以通过调用这些接口实现与Nayota平台的交互。
+
+## 2. SDK npm 安装
+```shell
+npm install nayota-show-sdk
+``` 
+
+## 3. SDK使用
+### 3.1 初始化SDK
+```javascript
+import NayotaSdk from 'nayota-show-sdk'
+NayotaSdk.config({
+  authTokenName: 'Admin-Token', // api接口存储的token到cookie的key名称
+  showServer: 'http://localhost:8080/api', // noyota-impossible-pro配置服务地址
+})
+// 调用你需要的模块名称
+import { alarmRecord } from 'nayota-show-sdk'
+// 引入接口模块的方法
+const { list, updateOne, create, delete } = alarmRecord
+// 正常调用
+list({ page:1, limit:50 })
 ```

package/api/alarmProgress.js

@@ -1,128 +1,211 @@
-/**
- * @file 报警进度接口
- * @module 报警进度接口
- * @category 报警模块
- */
-import { requestShow } from '../utils'
-
-
-/**
- * @typedef {Object} alarmProgress - 报警进度
- * @property {string} alarmRecord - 报警id
- * @property {number} processingState - 报警进度的处理状态 [{key: '待处理', value: 1}, {key: '处理中', value: 2}, {key: '已处理', value: 3}, {key: '云呼通知中', value: 4}, {key: '短信通知', value: 5}, {key: '缺岗', value: 6}, {key: '已通知', value: 7}, {key: '真实报警', value: 8}, {key: '测试', value: 9}, {key: '误报', value: 10}, {key: '云呼通知失败', value: 13}, {key: '推送给第三方', value: 14}, {key: '处理完成', value: 15}, {key: '人工处理', value: 16}, {key: '设备自动复位', value: 17}, {key: '短信发送失败', value: 18}, {key: '跟进中', value: 19}]
- * @property {number} event_time - 报警进度的处理时间 毫秒时间戳。
- * @property {string} desc - 报警进度的描述。
- * @example
- * 
- {
-    "_id": "67498c0ea2bd800009fa8931",
-    "alarmRecord": "67498c0ea2bd800009fa8906",
-    "processingState": 1,
-    "event_time": 1732873230764,
-    "desc": "通用部件-回路043944节点0155-正常"
-  }
-*/
-
-
-/**
- * 获取报警进度列表
- * @param {Object} query - 请求对象
- * @param {number} query.page - 页码
- * @param {number} query.limit - 每页数量
- * @param {string} query.label - 模糊查询关键字
- * @param {string} query.search - 模糊查询内容
- * @param {string} query.alarmRecord - 关联到AlarmRecord的引用。
- * @returns {number} code - 返回码，0表示成功
- * @returns {number} total - 报警进度总数
- * @returns {Array} rows - 报警进度数组 见表结构alarmProgress定义
- */
-export function list(query) {
-  return requestShow({
-    url: '/alarm-progress',
-    method: 'get',
-    params: query
-  })
-}
-
-/**
- * 新增报警进度记录
- * @param {object} data - 见表结构alarmProgress定义
- * @returns {number} code - 返回码，0表示成功
- * @returns {Object} data - 见表结构alarmProgress定义
- */
-export function create(data) {
-  return requestShow({
-    url: '/alarm-progress',
-    method: 'post',
-    data
-  })
-}
-
-/**
- * 获取报警进度详情
- * @param {string} id - 报警id 
-* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
-* @returns {number} code - 返回码，0表示成功。
-* @returns {string} _id - 报警进度id
-* @returns {Object} 见表结构alarmProgress定义
- */
-export function getOne(id) {
-  return requestShow({
-    url: `/alarm-progress/${id}`,
-    method: 'get'
-  })
-}
-
-
-/**
- * 编辑报警进度详情
- * @param {Object} data 修改数据对象
- * @param {string} data._id - 报警进度id
- * @param {Object} data.other 见表结构alarmProgress定义
-* @returns {number} code - 返回码，0表示成功。
-* @returns {Object} data - 报警进度对象 见表结构alarmProgress定义
- */
-export function updateOne(data) {
-  return requestShow({
-    url: `/alarm-progress/${data._id}`,
-    method: 'put',
-    data
-  })
-}
-
-/**
- * 删除进度
- * @param {string} id - 报警id 
-* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
-* @returns {number} code - 返回码，0表示成功。
-* @returns {Object} 见表结构alarmProgress定义
- */
-export function deleteOne(id) {
-  return requestShow({
-    url: `/alarm-progress/${id}`,
-    method: 'delete'
-  })
-}
-
-/**
- * 批量删除报警进度
- * @param {Array} ids - 报警进度ids 
-* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
-* @returns {number} code - 返回码，0表示成功。
- */
-export function deleteMany(ids) {
-  return requestShow({
-    url: '/alarm-progress',
-    method: 'delete',
-    data: ids // delete传递主体要包含在data里
-  })
-}
-
-export default {
-  list,
-  getOne,
-  create,
-  updateOne,
-  deleteOne,
-  deleteMany
-}
+/**
+ * @file 报警进度api
+ * @module 报警进度接口
+ * @category 报警管理
+ * @import
+ * import { alarmProgress } from 'nayota-show-sdk'
+ * const { list, getOne, create, updateOne, deleteOne, deleteMany } = alarmProgress
+ * list({ page: 1, limit: 50 })
+ */
+import { requestShow } from '../utils'
+
+
+/**
+ * @typedef {Object} AlarmProgress - 报警进度
+ * @property {string} alarmRecord - 报警id
+ * @property {number} processingState - 报警进度的处理状态 [{name: '待处理', value: 1}, {name: '处理中', value: 2}, {name: '已处理', value: 3}, {name: '云呼通知中', value: 4}, {name: '短信通知', value: 5}, {name: '缺岗', value: 6}, {name: '已通知', value: 7}, {name: '真实报警', value: 8}, {name: '测试', value: 9}, {name: '误报', value: 10}, {name: '云呼通知失败', value: 13}, {name: '推送给第三方', value: 14}, {name: '处理完成', value: 15}, {name: '人工处理', value: 16}, {name: '设备自动复位', value: 17}, {name: '短信发送失败', value: 18}, {name: '跟进中', value: 19}]
+ * @property {number} event_time - 报警进度的处理时间 毫秒时间戳。
+ * @property {string} desc - 报警进度的描述。
+ * @example
+ * 
+ {
+    "_id": "67498c0ea2bd800009fa8931",
+    "alarmRecord": "67498c0ea2bd800009fa8906",
+    "processingState": 1,
+    "event_time": 1732873230764,
+    "desc": "通用部件-回路043944节点0155-正常"
+  }
+*/
+
+
+/**
+ * 获取报警进度列表
+ * @param {Object} query - 请求对象
+ * @param {number} query.page - 页码
+ * @param {number} query.limit - 每页数量
+ * @param {string} query.label - 模糊查询关键字
+ * @param {string} query.search - 模糊查询内容
+ * @param {string} query.alarmRecord - 关联到AlarmRecord的引用。
+ * @example
+ * { page: 1, limit: 10, label: 'desc', search: '报警', alarmRecord: '67498c0ea2bd800009fa8906' }
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {number} total - 报警进度总数
+ * @returns {Array} rows - 报警进度数组 见表结构alarmProgress定义
+ * @example
+ * {
+ *   "code": 0,
+ *   "total": 1,
+ *   "rows": [
+      {
+        "_id": "67498c0ea2bd800009fa8931",
+        "alarmRecord": "67498c0ea2bd800009fa8906",
+        "processingState": 1,
+        "event_time": 1732873230764,
+        "desc": "通用部件-回路043944节点0155-正常"
+      }
+    ]}
+ */
+export function list(query) {
+  return requestShow({
+    url: '/alarm-progress',
+    method: 'get',
+    params: query
+  })
+}
+
+/**
+ * 新增报警进度记录
+ * @param {object} data - 见表结构alarmProgress定义
+ * @example
+ * {
+    "alarmRecord": "67498c0ea2bd800009fa8906",
+    "processingState": 1,
+    "event_time": 1732873230764,
+    "desc": "通用部件-回路043944节点0155-正常"
+  }
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {Object} data - 见表结构alarmProgress定义
+ * @example
+ * {
+ *   "code": 0,
+ *   "data": {
+ *     "_id": "67498c0ea2bd800009fa8931",
+ *     "alarmRecord": "67498c0ea2bd800009fa8906",
+ *     "processingState": 1,
+ *     "event_time": 1732873230764,
+ *     "desc": "通用部件-回路043944节点0155-正常"
+ *   }
+ * }
+ */
+export function create(data) {
+  return requestShow({
+    url: '/alarm-progress',
+    method: 'post',
+    data
+  })
+}
+
+/**
+ * 获取报警进度详情
+ * @param {string} id - 报警id 
+ * @example
+ * 67498c0ea2bd800009fa8931
+ * @returns {number} code - 返回码，0表示成功。
+ * @returns {Object} data - 见表结构alarmProgress定义
+ * @example
+ * {
+ *   "code": 0,
+ *   "data": {
+ *     "_id": "67498c0ea2bd800009fa8931",
+ *     "alarmRecord": "67498c0ea2bd800009fa8906",
+ *     "processingState": 1,
+ *     "event_time": 1732873230764,
+ *     "desc": "通用部件-回路043944节点0155-正常"
+ *   }
+ }
+ */
+export function getOne(id) {
+  return requestShow({
+    url: `/alarm-progress/${id}`,
+    method: 'get'
+  })
+}
+
+
+/**
+ * 编辑报警进度详情
+ * @param {Object} data 修改数据对象
+ * @example
+ * {
+    "_id": "67498c0ea2bd800009fa8931",
+    "alarmRecord": "67498c0ea2bd800009fa8906",
+    "processingState": 1,
+    "event_time": 1732873230764,
+    "desc": "通用部件-回路043944节点0155-正常"
+ }
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 报警进度对象 见表结构alarmProgress定义
+* @example
+* {
+*   "code": 0,
+*   "data": {
+*     "_id": "67498c0ea2bd800009fa8931",
+*     "alarmRecord": "67498c0ea2bd800009fa8906",
+*     "processingState": 1,
+*     "event_time": 1732873230764,
+*     "desc": "通用部件-回路043944节点0155-正常"
+*   }
+* }
+ */
+export function updateOne(data) {
+  return requestShow({
+    url: `/alarm-progress/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+/**
+ * 删除进度
+ * @param {string} id - 报警id 
+ * @example
+ * 67498c0ea2bd800009fa8931
+* @returns {number} code - 返回码，0表示成功。
+* @returns {Object} data - 见表结构alarmProgress定义
+* @example
+* {
+*   "code": 0,
+*   "data": {
+*     "_id": "67498c0ea2bd800009fa8931",
+*     "alarmRecord": "67498c0ea2bd800009fa8906",
+*     "processingState": 1,
+*     "event_time": 1732873230764,
+*     "desc": "通用部件-回路043944节点0155-正常"
+*   }
+* }
+ */
+export function deleteOne(id) {
+  return requestShow({
+    url: `/alarm-progress/${id}`,
+    method: 'delete'
+  })
+}
+
+/**
+ * 批量删除报警进度
+ * @param {Array} ids - 报警进度ids 
+ * @example
+ * ['67498c0ea2bd800009fa8931', '67498c0ea2bd800009fa8932']
+* @returns {Object} - 响应对象，其中包含表示操作成功与否的代码。
+* @returns {number} code - 返回码，0表示成功。
+* @example
+* {
+*   "code": 0
+* }
+ */
+export function deleteMany(ids) {
+  return requestShow({
+    url: '/alarm-progress',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+
+export default {
+  list,
+  getOne,
+  create,
+  updateOne,
+  deleteOne,
+  deleteMany
+}