nayota-show-sdk 0.0.4 → 0.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/api/product.js CHANGED
@@ -156,6 +156,7 @@ import { requestShow as request } from '../utils'
156
156
  * }
157
157
  * 摄像头设备创建所需参数
158
158
  * 平台摄像头所传参数
159
+ * 1. 当三方摄像头账号type为2时,number和channelNo必选,其余type类型number必选channelNo可选
159
160
  * {
160
161
  * name: '摄像头设备',
161
162
  * depart: '667d2ecc52d21700095b58b4',
@@ -204,6 +205,95 @@ function createAllDevice(data) {
204
205
  })
205
206
  }
206
207
 
208
+ /**
209
+ * 查询产品列表
210
+ * @param {Object} query - 查询条件
211
+ * @param {string} query.name - 设备名称。
212
+ *
213
+ */
214
+ function list(query) {
215
+ return request({
216
+ url: '/products',
217
+ method: 'get',
218
+ params: query
219
+ })
220
+ }
221
+
222
+ /**
223
+ * 创建产品信息
224
+ * @param {Object} data - 创建产品信息
225
+ * @param {string} data.name - 产品名称。
226
+ * @param {string} data.productCode - 产品名称。
227
+ * @param {string} data.tags - 产品标签
228
+ * @param {string} data.brand - 产品品牌
229
+ * @param {string} data.img - 产品图片
230
+ * @param {string} data.info - 产品详情
231
+ * @param {string} data.access - 接入方式
232
+ * @param {string} data.supplyModel - 供电方式
233
+ * @param {string} data.protocolType - 通信协议
234
+ * @param {string} data.description - 产品描述
235
+ * @param {string} data.hardwareWord - 设备字典
236
+ * @param {string} data.addressDesc - 地址介绍
237
+ * @param {string} data.deviceUI - 产品名称。
238
+ * @param {string} data.deviceType - IOT设备类型
239
+ */
240
+ function create(data) {
241
+ return request({
242
+ url: '/products',
243
+ method: 'post',
244
+ data
245
+ })
246
+ }
247
+ /**
248
+ * 查询单个产品
249
+ * @param {Object} id - 产品id
250
+ */
251
+ function getOne(id) {
252
+ return request({
253
+ url: '/products/' + id,
254
+ method: 'get'
255
+ })
256
+ }
257
+ /**
258
+ * 更新单个产品
259
+ * @param {Object} data
260
+ * @param {string} data._id - 产品id
261
+ * @param {string} data.name - 产品名称
262
+ */
263
+ function updateOne(data) {
264
+ return request({
265
+ url: `/products/${data._id}`,
266
+ method: 'put',
267
+ data
268
+ })
269
+ }
270
+ /**
271
+ * 删除单个产品
272
+ * @param {Object} id - 产品id
273
+ */
274
+ function deleteOne(id) {
275
+ return request({
276
+ url: `/products/${id}`,
277
+ method: 'delete'
278
+ })
279
+ }
280
+ /**
281
+ * 批量删除产品
282
+ * @param {Object} ids - 产品id数组
283
+ */
284
+ function deleteMany(ids) {
285
+ return request({
286
+ url: '/products',
287
+ method: 'delete',
288
+ data: ids // delete传递主体要包含在data里
289
+ })
290
+ }
207
291
  export default {
208
- createAllDevice
292
+ createAllDevice,
293
+ create,
294
+ list,
295
+ getOne,
296
+ updateOne,
297
+ deleteOne,
298
+ deleteMany
209
299
  }
package/api/router.js ADDED
@@ -0,0 +1,93 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 路由api
4
+ * @module 路由接口
5
+ */
6
+ /**
7
+ *
8
+ * @param {*} query
9
+ * @param {number} query.page - 页码
10
+ * @param {number} query.limit - 每页数量
11
+ * @returns {number} code - 返回码,0表示成功
12
+ * @returns {number} total - 路由总数
13
+ * @returns {Array} rows - 路由数组
14
+ * @returns {string} rows._id - 路由id
15
+ * @returns {string} rows.name - 路由名称
16
+ * @returns {string} rows.path - 路由路径
17
+ * @returns {number} rows.level - 路由等级
18
+ * @returns {number} rows.sort - 排序序号
19
+ * @returns {Array<mongoose.Schema.Types.ObjectId>} rows.children - 子路由列表
20
+ * @returns {('all'|'get'|'post'|'put'|'delete')} rows.method - HTTP请求方法
21
+ * @returns {string} rows.desc - 路由描述
22
+ * @returns {Array<mongoose.Schema.Types.ObjectId>} rows.roles - 关联的角色列表
23
+ * @returns {string} rows.icon - 路由图标
24
+ */
25
+ export function list(query) {
26
+ return request({
27
+ url: '/routers',
28
+ method: 'get',
29
+ params: query
30
+ })
31
+ }
32
+
33
+ /**
34
+ * 新增路由
35
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
36
+ * @returns {number} code - 返回码,0表示成功
37
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
38
+ */
39
+ export function create(data) {
40
+ return requestShow({
41
+ url: '/routers',
42
+ method: 'post',
43
+ data
44
+ })
45
+ }
46
+
47
+ /**
48
+ * 修改路由
49
+ * @param {Object} data - 包含路由的请求体 属性见list返回字段。
50
+ * @returns {number} code - 返回码,0表示成功
51
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
52
+ */
53
+ export function updateOne(data) {
54
+ return requestShow({
55
+ url: `/routers/${data._id}`,
56
+ method: 'put',
57
+ data
58
+ })
59
+ }
60
+ /**
61
+ * 删除路由
62
+ * @param {string} id - 删除的路由id。
63
+ * @returns {number} code - 返回码,0表示成功
64
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
65
+ */
66
+ export function deleteOne(id) {
67
+ return requestShow({
68
+ url: `/routers/${id}`,
69
+ method: 'delete'
70
+ })
71
+ }
72
+
73
+ /**
74
+ * 批量删除路由
75
+ * @param {Array} ids - 删除的路由ids。
76
+ * @returns {number} code - 返回码,0表示成功
77
+ */
78
+ export function deleteMany(ids) {
79
+ return requestShow({
80
+ url: '/routers',
81
+ method: 'delete',
82
+ data: ids // delete传递主体要包含在data里
83
+ })
84
+ }
85
+
86
+ export default {
87
+ list,
88
+ create,
89
+ updateOne,
90
+ deleteOne,
91
+ deleteMany
92
+ }
93
+
package/index.js CHANGED
@@ -4,10 +4,12 @@ import emitter from './utils/EventEmitter'
4
4
  import alarmRecord from './api/alarmRecord'
5
5
  import alarmProgress from './api/alarmProgress'
6
6
  import systeminfo from './api/systeminfo'
7
+ import router from './api/router'
7
8
  const api = {
8
9
  alarmRecord,
9
10
  alarmProgress,
10
- systeminfo
11
+ systeminfo,
12
+ router
11
13
  }
12
14
 
13
15
  export default { config: options => {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nayota-show-sdk",
3
- "version": "0.0.4",
3
+ "version": "0.0.6",
4
4
  "description": "nayota-show-server rest-api",
5
5
  "type": "module",
6
6
  "main": "index.js",