nayota-show-sdk 0.1.3 → 1.0.0

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.
@@ -0,0 +1,113 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 看板路由api
4
+ * @module 看板路由接口
5
+ */
6
+
7
+
8
+ /**
9
+ * 菜单类型type
10
+ * @readonly
11
+ * @enum {string}
12
+ */
13
+ var type = {
14
+ group: '分组菜单',
15
+ view: '页面菜单'
16
+ }
17
+
18
+ /**
19
+ * @typedef {Object} appRouter看板路由
20
+ * @property {string} _id - 看板路由id.
21
+ * @property {string} application - 所属应用.
22
+ * @property {array} routes - 看板对应的子菜单信息.
23
+ * @property {array} routes.children - 子菜单的子页面信息
24
+ * @property {string} routes.children.icon - 子页面的图标
25
+ * @property {string} routes.children.name - 子页面的名称
26
+ * @property {string} routes.children.identifier - 子页面的唯一标识
27
+ * @property {string} routes.children.view - 子页面的页面_id
28
+ * @property {string} routes.children.customView - 子页面的自定义页面信息
29
+ * @property {string} routes.icon - 子菜单的图标
30
+ * @property {string} routes.name - 子菜单的名称
31
+ * @property {string} routes.identifier - 子菜单的唯一标识
32
+ * @property {string} routes.type - 子菜单的type类型查看枚举type
33
+ */
34
+
35
+
36
+ /**
37
+ *
38
+ * @param {*} query
39
+ * @param {number} query.page - 页码
40
+ * @param {number} query.limit - 每页数量
41
+ * @returns {number} code - 返回码,0表示成功
42
+ * @returns {number} total - 看板路由总数
43
+ * @returns {Array} rows - 看板路由数组查看数据定义
44
+ */
45
+ export function list(query) {
46
+ return requestShow({
47
+ url: '/app-routers',
48
+ method: 'get',
49
+ params: query
50
+ })
51
+ }
52
+
53
+ /**
54
+ * 新增看板路由
55
+ * @param {Object} data - 包含看板路由的请求体 属性见list返回字段。
56
+ * @returns {number} code - 返回码,0表示成功
57
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
58
+ */
59
+ export function create(data) {
60
+ return requestShow({
61
+ url: '/app-routers',
62
+ method: 'post',
63
+ data
64
+ })
65
+ }
66
+
67
+ /**
68
+ * 修改看板路由
69
+ * @param {Object} data - 包含看板路由的请求体 属性见list返回字段。
70
+ * @returns {number} code - 返回码,0表示成功
71
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
72
+ */
73
+ export function updateOne(data) {
74
+ return requestShow({
75
+ url: `/app-routers/${data._id}`,
76
+ method: 'put',
77
+ data
78
+ })
79
+ }
80
+ /**
81
+ * 删除看板路由
82
+ * @param {string} id - 删除的看板路由id。
83
+ * @returns {number} code - 返回码,0表示成功
84
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
85
+ */
86
+ export function deleteOne(id) {
87
+ return requestShow({
88
+ url: `/app-routers/${id}`,
89
+ method: 'delete'
90
+ })
91
+ }
92
+
93
+ /**
94
+ * 批量删除看板路由
95
+ * @param {Array} ids - 删除的看板路由ids。
96
+ * @returns {number} code - 返回码,0表示成功
97
+ */
98
+ export function deleteMany(ids) {
99
+ return requestShow({
100
+ url: '/app-routers',
101
+ method: 'delete',
102
+ data: ids // delete传递主体要包含在data里
103
+ })
104
+ }
105
+
106
+ export default {
107
+ list,
108
+ create,
109
+ updateOne,
110
+ deleteOne,
111
+ deleteMany
112
+ }
113
+
@@ -0,0 +1,101 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 应用信息api
4
+ * @module 应用信息接口
5
+ */
6
+
7
+
8
+
9
+ /**
10
+ * 应用类型type
11
+ * @readonly
12
+ * @enum {number}
13
+ */
14
+ var type = {
15
+ 0: '本地应用',
16
+ 1: '平台应用'
17
+ }
18
+ /**
19
+ *
20
+ * @param {*} query
21
+ * @param {number} query.page - 页码
22
+ * @param {number} query.limit - 每页数量
23
+ * @returns {number} code - 返回码,0表示成功
24
+ * @returns {number} total - 应用信息总数
25
+ * @returns {Array} rows - 应用信息数组
26
+ * @returns {string} rows._id - 应用信息id
27
+ * @returns {string} rows.name - 应用信息名称
28
+ * @returns {string} rows.icon - 应用图标
29
+ * @returns {string} rows.color - 图标颜色
30
+ * @returns {string} rows.type - 应用类型查看枚举type
31
+ * @returns {string} rows.url - 应用路径
32
+ */
33
+ export function list(query) {
34
+ return requestShow({
35
+ url: '/applications',
36
+ method: 'get',
37
+ params: query
38
+ })
39
+ }
40
+
41
+ /**
42
+ * 新增应用信息
43
+ * @param {Object} data - 包含应用信息的请求体 属性见list返回字段。
44
+ * @returns {number} code - 返回码,0表示成功
45
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
46
+ */
47
+ export function create(data) {
48
+ return requestShow({
49
+ url: '/applications',
50
+ method: 'post',
51
+ data
52
+ })
53
+ }
54
+
55
+ /**
56
+ * 修改应用信息
57
+ * @param {Object} data - 包含应用信息的请求体 属性见list返回字段。
58
+ * @returns {number} code - 返回码,0表示成功
59
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
60
+ */
61
+ export function updateOne(data) {
62
+ return requestShow({
63
+ url: `/applications/${data._id}`,
64
+ method: 'put',
65
+ data
66
+ })
67
+ }
68
+ /**
69
+ * 删除应用信息
70
+ * @param {string} id - 删除的应用信息id。
71
+ * @returns {number} code - 返回码,0表示成功
72
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
73
+ */
74
+ export function deleteOne(id) {
75
+ return requestShow({
76
+ url: `/applications/${id}`,
77
+ method: 'delete'
78
+ })
79
+ }
80
+
81
+ /**
82
+ * 批量删除应用信息
83
+ * @param {Array} ids - 删除的应用信息ids。
84
+ * @returns {number} code - 返回码,0表示成功
85
+ */
86
+ export function deleteMany(ids) {
87
+ return requestShow({
88
+ url: '/applications',
89
+ method: 'delete',
90
+ data: ids // delete传递主体要包含在data里
91
+ })
92
+ }
93
+
94
+ export default {
95
+ list,
96
+ create,
97
+ updateOne,
98
+ deleteOne,
99
+ deleteMany
100
+ }
101
+
@@ -0,0 +1,112 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 系统组件api
4
+ * @module 系统组件接口
5
+ */
6
+
7
+ /**
8
+ * 组件加载类型status
9
+ * @readonly
10
+ * @enum {string}
11
+ */
12
+ var status = {
13
+ 本地组件: 'local',
14
+ 外部组件: 'remote'
15
+ }
16
+
17
+
18
+ /**
19
+ * 组件类型type
20
+ * @readonly
21
+ * @enum {string}
22
+ */
23
+ var type = {
24
+ 页面组件: 'view',
25
+ UI组件: 'device_ui',
26
+ BA组件: 'ba_card'
27
+ }
28
+ /**
29
+ *
30
+ * @param {*} query
31
+ * @param {number} query.page - 页码
32
+ * @param {number} query.limit - 每页数量
33
+ * @returns {number} code - 返回码,0表示成功
34
+ * @returns {number} total - 系统组件总数
35
+ * @returns {Array} rows - 系统组件数组
36
+ * @returns {string} rows._id - 系统组件id
37
+ * @returns {string} rows.name - 系统组件名称必须唯一
38
+ * @returns {string} rows.code - 系统组件编码必须唯一
39
+ * @returns {string} rows.status - 组件加载类型查看枚举status
40
+ * @returns {string} rows.type - 组件类型查看枚举type
41
+ * @returns {boolean} rows.canDecode - 组件是否可被解构默认为false
42
+ * @returns {number} rows.uiWidth - UI原始设计宽度单位px默认350
43
+ */
44
+ export function list(query) {
45
+ return requestShow({
46
+ url: '/componentss',
47
+ method: 'get',
48
+ params: query
49
+ })
50
+ }
51
+
52
+ /**
53
+ * 新增系统组件
54
+ * @param {Object} data - 包含系统组件的请求体 属性见list返回字段。
55
+ * @returns {number} code - 返回码,0表示成功
56
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
57
+ */
58
+ export function create(data) {
59
+ return requestShow({
60
+ url: '/componentss',
61
+ method: 'post',
62
+ data
63
+ })
64
+ }
65
+
66
+ /**
67
+ * 修改系统组件
68
+ * @param {Object} data - 包含系统组件的请求体 属性见list返回字段。
69
+ * @returns {number} code - 返回码,0表示成功
70
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
71
+ */
72
+ export function updateOne(data) {
73
+ return requestShow({
74
+ url: `/componentss/${data._id}`,
75
+ method: 'put',
76
+ data
77
+ })
78
+ }
79
+ /**
80
+ * 删除系统组件
81
+ * @param {string} id - 删除的系统组件id。
82
+ * @returns {number} code - 返回码,0表示成功
83
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
84
+ */
85
+ export function deleteOne(id) {
86
+ return requestShow({
87
+ url: `/componentss/${id}`,
88
+ method: 'delete'
89
+ })
90
+ }
91
+
92
+ /**
93
+ * 批量删除系统组件
94
+ * @param {Array} ids - 删除的系统组件ids。
95
+ * @returns {number} code - 返回码,0表示成功
96
+ */
97
+ export function deleteMany(ids) {
98
+ return requestShow({
99
+ url: '/componentss',
100
+ method: 'delete',
101
+ data: ids // delete传递主体要包含在data里
102
+ })
103
+ }
104
+
105
+ export default {
106
+ list,
107
+ create,
108
+ updateOne,
109
+ deleteOne,
110
+ deleteMany
111
+ }
112
+
package/api/product.js CHANGED
@@ -110,11 +110,12 @@ var tcpType = {
110
110
  * @property {string} depart - 可视化层级的id
111
111
  * @property {string} thirdPartyCameraAccount - 平台账号id,查config三方摄像头账号接口,平台摄像头必选。
112
112
  * @property {number} number - 设备序号,平台摄像头必选。
113
- * @property {number} channelNo - 通道号,平台摄像头且三方摄像头的类型为2时必选,其余三方摄像头类型可选。
113
+ * @property {number} channelNo - 通道号,平台摄像头且三方摄像头账号的类型为2时必选,其余三方摄像头账号类型可选。
114
114
  * @property {string} iconName - 设备图标。
115
115
  * @property {string} local_ip - 本地RTSP地址,本地摄像头必选。
116
116
  * @property {string} local_username - 本地用户名,本地摄像头必选。
117
117
  * @property {string} local_password - 本地密码,本地摄像头必选。
118
+ * @property {boolean} isTransform - 是否转码,本地摄像头必选且默认开启,平台摄像头且三方摄像头账号的类型为2和4时必选。
118
119
  * @property {string} describe - 设备备注。
119
120
  * @property {boolean} line - 设备在离线。
120
121
  * @property {boolean} hasPtz - 是否带云台。
@@ -216,7 +217,8 @@ var tcpType = {
216
217
  * }
217
218
  * 摄像头设备创建所需参数
218
219
  * 平台摄像头所传参数
219
- * 1. 当三方摄像头账号type为2时,number和channelNo必选,其余type类型number必选channelNo可选
220
+ * 1. 当三方摄像头账号的类型为2时,number和channelNo必选,其余类型number必选
221
+ * 2. 当三方摄像头账号的类型为2或4时,isTransform必选
220
222
  * {
221
223
  * name: '摄像头设备',
222
224
  * depart: '667d2ecc52d21700095b58b4',
@@ -227,6 +229,7 @@ var tcpType = {
227
229
  * describe: '备注',
228
230
  * line: true,
229
231
  * hasPtz: true,
232
+ * isTransform: true
230
233
  * }
231
234
  * 本地摄像头所传参数
232
235
  * {
@@ -0,0 +1,100 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 关联平台api
4
+ * @module 关联平台接口
5
+ */
6
+
7
+ /**
8
+ * 平台类型platformType
9
+ * @readonly
10
+ * @enum {number}
11
+ */
12
+ var platformType = {
13
+ 内部: 1,
14
+ 外部: 2
15
+ }
16
+ /**
17
+ *
18
+ * @param {*} query
19
+ * @param {number} query.page - 页码
20
+ * @param {number} query.limit - 每页数量
21
+ * @returns {number} code - 返回码,0表示成功
22
+ * @returns {number} total - 关联平台总数
23
+ * @returns {Array} rows - 关联平台数组
24
+ * @returns {string} rows._id - 关联平台id
25
+ * @returns {string} rows.name - 关联平台名称必须唯一
26
+ * @returns {string} rows.url - 关联地址
27
+ * @returns {boolean} rows.token - 是否携带token
28
+ * @returns {string} rows.remark - 备注
29
+ * @returns {number} rows.platformType - 平台类型查看枚举平台类型
30
+ * @returns {array} rows.applications - 所属应用。
31
+ */
32
+ export function list(query) {
33
+ return requestShow({
34
+ url: '/relationPlatforms',
35
+ method: 'get',
36
+ params: query
37
+ })
38
+ }
39
+
40
+ /**
41
+ * 新增关联平台
42
+ * @param {Object} data - 包含关联平台的请求体 属性见list返回字段。
43
+ * @returns {number} code - 返回码,0表示成功
44
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
45
+ */
46
+ export function create(data) {
47
+ return requestShow({
48
+ url: '/relationPlatforms',
49
+ method: 'post',
50
+ data
51
+ })
52
+ }
53
+
54
+ /**
55
+ * 修改关联平台
56
+ * @param {Object} data - 包含关联平台的请求体 属性见list返回字段。
57
+ * @returns {number} code - 返回码,0表示成功
58
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
59
+ */
60
+ export function updateOne(data) {
61
+ return requestShow({
62
+ url: `/relationPlatforms/${data._id}`,
63
+ method: 'put',
64
+ data
65
+ })
66
+ }
67
+ /**
68
+ * 删除关联平台
69
+ * @param {string} id - 删除的关联平台id。
70
+ * @returns {number} code - 返回码,0表示成功
71
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
72
+ */
73
+ export function deleteOne(id) {
74
+ return requestShow({
75
+ url: `/relationPlatforms/${id}`,
76
+ method: 'delete'
77
+ })
78
+ }
79
+
80
+ /**
81
+ * 批量删除关联平台
82
+ * @param {Array} ids - 删除的关联平台ids。
83
+ * @returns {number} code - 返回码,0表示成功
84
+ */
85
+ export function deleteMany(ids) {
86
+ return requestShow({
87
+ url: '/relationPlatforms',
88
+ method: 'delete',
89
+ data: ids // delete传递主体要包含在data里
90
+ })
91
+ }
92
+
93
+ export default {
94
+ list,
95
+ create,
96
+ updateOne,
97
+ deleteOne,
98
+ deleteMany
99
+ }
100
+
package/api/svglib.js ADDED
@@ -0,0 +1,92 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 图标api
4
+ * @module 图标接口
5
+ */
6
+
7
+
8
+
9
+ /**
10
+ *
11
+ * @param {*} query
12
+ * @param {number} query.page - 页码
13
+ * @param {number} query.limit - 每页数量
14
+ * @returns {number} code - 返回码,0表示成功
15
+ * @returns {number} total - 图标总数
16
+ * @returns {Array} rows - 图标数组
17
+ * @returns {string} rows._id - 图标id
18
+ * @returns {string} rows.name - 图标名称必须唯一
19
+ * @returns {number} rows.box_x1 - 起始X
20
+ * @returns {number} rows.box_x2 - 结束X
21
+ * @returns {number} rows.box_y1 - 起始Y
22
+ * @returns {number} rows.box_y2 - 结束Y
23
+ */
24
+ export function list(query) {
25
+ return requestShow({
26
+ url: '/svglibs',
27
+ method: 'get',
28
+ params: query
29
+ })
30
+ }
31
+
32
+ /**
33
+ * 新增图标
34
+ * @param {Object} data - 包含图标的请求体 属性见list返回字段。
35
+ * @returns {number} code - 返回码,0表示成功
36
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
37
+ */
38
+ export function create(data) {
39
+ return requestShow({
40
+ url: '/svglibs',
41
+ method: 'post',
42
+ data
43
+ })
44
+ }
45
+
46
+ /**
47
+ * 修改图标
48
+ * @param {Object} data - 包含图标的请求体 属性见list返回字段。
49
+ * @returns {number} code - 返回码,0表示成功
50
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
51
+ */
52
+ export function updateOne(data) {
53
+ return requestShow({
54
+ url: `/svglibs/${data._id}`,
55
+ method: 'put',
56
+ data
57
+ })
58
+ }
59
+ /**
60
+ * 删除图标
61
+ * @param {string} id - 删除的图标id。
62
+ * @returns {number} code - 返回码,0表示成功
63
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
64
+ */
65
+ export function deleteOne(id) {
66
+ return requestShow({
67
+ url: `/svglibs/${id}`,
68
+ method: 'delete'
69
+ })
70
+ }
71
+
72
+ /**
73
+ * 批量删除图标
74
+ * @param {Array} ids - 删除的图标ids。
75
+ * @returns {number} code - 返回码,0表示成功
76
+ */
77
+ export function deleteMany(ids) {
78
+ return requestShow({
79
+ url: '/svglibs',
80
+ method: 'delete',
81
+ data: ids // delete传递主体要包含在data里
82
+ })
83
+ }
84
+
85
+ export default {
86
+ list,
87
+ create,
88
+ updateOne,
89
+ deleteOne,
90
+ deleteMany
91
+ }
92
+
package/api/tag.js ADDED
@@ -0,0 +1,90 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 层级标签api
4
+ * @module 层级标签接口
5
+ */
6
+
7
+
8
+
9
+ /**
10
+ *
11
+ * @param {*} query
12
+ * @param {number} query.page - 页码
13
+ * @param {number} query.limit - 每页数量
14
+ * @returns {number} code - 返回码,0表示成功
15
+ * @returns {number} total - 层级标签总数
16
+ * @returns {Array} rows - 层级标签数组
17
+ * @returns {string} rows._id - 层级标签id
18
+ * @returns {string} rows.name - 层级标签名称
19
+ * @returns {boolean} rows.status - 层级标签状态
20
+ * @returns {string} rows.remark - 层级标签备注
21
+ */
22
+ export function list(query) {
23
+ return requestShow({
24
+ url: '/departTags',
25
+ method: 'get',
26
+ params: query
27
+ })
28
+ }
29
+
30
+ /**
31
+ * 新增层级标签
32
+ * @param {Object} data - 包含层级标签的请求体 属性见list返回字段。
33
+ * @returns {number} code - 返回码,0表示成功
34
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
35
+ */
36
+ export function create(data) {
37
+ return requestShow({
38
+ url: '/departTags',
39
+ method: 'post',
40
+ data
41
+ })
42
+ }
43
+
44
+ /**
45
+ * 修改层级标签
46
+ * @param {Object} data - 包含层级标签的请求体 属性见list返回字段。
47
+ * @returns {number} code - 返回码,0表示成功
48
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
49
+ */
50
+ export function updateOne(data) {
51
+ return requestShow({
52
+ url: `/departTags/${data._id}`,
53
+ method: 'put',
54
+ data
55
+ })
56
+ }
57
+ /**
58
+ * 删除层级标签
59
+ * @param {string} id - 删除的层级标签id。
60
+ * @returns {number} code - 返回码,0表示成功
61
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
62
+ */
63
+ export function deleteOne(id) {
64
+ return requestShow({
65
+ url: `/departTags/${id}`,
66
+ method: 'delete'
67
+ })
68
+ }
69
+
70
+ /**
71
+ * 批量删除层级标签
72
+ * @param {Array} ids - 删除的层级标签ids。
73
+ * @returns {number} code - 返回码,0表示成功
74
+ */
75
+ export function deleteMany(ids) {
76
+ return requestShow({
77
+ url: '/departTags',
78
+ method: 'delete',
79
+ data: ids // delete传递主体要包含在data里
80
+ })
81
+ }
82
+
83
+ export default {
84
+ list,
85
+ create,
86
+ updateOne,
87
+ deleteOne,
88
+ deleteMany
89
+ }
90
+
package/api/upload.js ADDED
@@ -0,0 +1,102 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 文件管理api
4
+ * @module 文件管理接口
5
+ */
6
+
7
+
8
+ /**
9
+ * 文件来源from
10
+ * @readonly
11
+ * @enum {number}
12
+ */
13
+ var from = {
14
+ 默认文件: 0,
15
+ 展示文件: 1
16
+ }
17
+
18
+ /**
19
+ *
20
+ * @param {*} query
21
+ * @param {number} query.page - 页码
22
+ * @param {number} query.limit - 每页数量
23
+ * @returns {number} code - 返回码,0表示成功
24
+ * @returns {number} total - 文件总数
25
+ * @returns {Array} rows - 文件数组
26
+ * @returns {string} rows._id - 文件id
27
+ * @returns {string} rows.name - 文件名
28
+ * @returns {string} rows.size - 文件大小
29
+ * @returns {string} rows.path - 文件路径
30
+ * @returns {string} rows.from - 文件来源查看枚举from
31
+ * @returns {string} rows.lastUseAt - 最后使用时间
32
+ */
33
+ export function list(query) {
34
+ return requestShow({
35
+ url: '/uploads',
36
+ method: 'get',
37
+ params: query
38
+ })
39
+ }
40
+
41
+ /**
42
+ * 上传文件
43
+ * @param {Object} data - 包含文件的请求体 属性见list返回字段。
44
+ * @param {string} data.file - 二进制文件
45
+ * @returns {number} code - 返回码,0表示成功
46
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
47
+ */
48
+ export function upload(data) {
49
+ return requestShow({
50
+ url: '/uploads',
51
+ method: 'post',
52
+ data
53
+ })
54
+ }
55
+
56
+ /**
57
+ * 修改文件
58
+ * @param {Object} data - 包含文件的请求体 属性见list返回字段。
59
+ * @returns {number} code - 返回码,0表示成功
60
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
61
+ */
62
+ export function updateOne(data) {
63
+ return requestShow({
64
+ url: `/uploads/${data._id}`,
65
+ method: 'put',
66
+ data
67
+ })
68
+ }
69
+ /**
70
+ * 删除文件
71
+ * @param {string} id - 删除的文件id。
72
+ * @returns {number} code - 返回码,0表示成功
73
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
74
+ */
75
+ export function deleteOne(id) {
76
+ return requestShow({
77
+ url: `/uploads/${id}`,
78
+ method: 'delete'
79
+ })
80
+ }
81
+
82
+ /**
83
+ * 批量删除文件
84
+ * @param {Array} ids - 删除的文件ids。
85
+ * @returns {number} code - 返回码,0表示成功
86
+ */
87
+ export function deleteMany(ids) {
88
+ return requestShow({
89
+ url: '/uploads',
90
+ method: 'delete',
91
+ data: ids // delete传递主体要包含在data里
92
+ })
93
+ }
94
+
95
+ export default {
96
+ list,
97
+ create,
98
+ updateOne,
99
+ deleteOne,
100
+ deleteMany
101
+ }
102
+
@@ -0,0 +1,122 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 用户权限配置api
4
+ * @module 用户权限配置接口
5
+ */
6
+
7
+
8
+ /**
9
+ * 页面类型type
10
+ * @readonly
11
+ * @enum {string}
12
+ */
13
+ var type = {
14
+ 基础: 'base',
15
+ 设备UI: 'layoutDevicePanel',
16
+ 摄像头: 'videosPanel'
17
+ }
18
+
19
+ /**
20
+ * UI类型uiType
21
+ * @readonly
22
+ * @enum {string}
23
+ */
24
+ var uiType = {
25
+ UI模型: 'uiModel',
26
+ UI组件: 'uiComponent',
27
+ }
28
+
29
+ /**
30
+ * @typedef {Object} userDevice用户权限配置
31
+ * @property {string} _id - 用户权限配置id.
32
+ * @property {string} user - 用户id.
33
+ * @property {array} devices - 绑定的设备id数组.
34
+ * @property {array} apps - 绑定的看板路由id.
35
+ * @property {array} approutes - 绑定的应用中的页面和路由.
36
+ * @property {string} approutes.application - 所属应用.
37
+ * @property {string} approutes.appRouter - 看板路由id.
38
+ * @property {array} approutes.children - 子级信息.
39
+ * @property {string} introduction - 整体介绍.
40
+ * @property {number} buildingArea - 楼宇占地面积.
41
+ * @property {number} averageArea - 面均面积.
42
+ */
43
+
44
+
45
+ /**
46
+ *
47
+ * @param {*} query
48
+ * @param {number} query.page - 页码
49
+ * @param {number} query.limit - 每页数量
50
+ * @returns {number} code - 返回码,0表示成功
51
+ * @returns {number} total - 用户权限配置总数
52
+ * @returns {Array} rows - 用户权限配置数组查看数据定义
53
+ */
54
+ export function list(query) {
55
+ return requestShow({
56
+ url: '/user-devices',
57
+ method: 'get',
58
+ params: query
59
+ })
60
+ }
61
+
62
+ /**
63
+ * 新增用户权限配置
64
+ * @param {Object} data - 包含用户权限配置的请求体 属性见list返回字段。
65
+ * @returns {number} code - 返回码,0表示成功
66
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
67
+ */
68
+ export function create(data) {
69
+ return requestShow({
70
+ url: '/user-devices',
71
+ method: 'post',
72
+ data
73
+ })
74
+ }
75
+
76
+ /**
77
+ * 修改用户权限配置
78
+ * @param {Object} data - 包含用户权限配置的请求体 属性见list返回字段。
79
+ * @returns {number} code - 返回码,0表示成功
80
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
81
+ */
82
+ export function updateOne(data) {
83
+ return requestShow({
84
+ url: `/user-devices/${data._id}`,
85
+ method: 'put',
86
+ data
87
+ })
88
+ }
89
+ /**
90
+ * 删除用户权限配置
91
+ * @param {string} id - 删除的用户权限配置id。
92
+ * @returns {number} code - 返回码,0表示成功
93
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
94
+ */
95
+ export function deleteOne(id) {
96
+ return requestShow({
97
+ url: `/user-devices/${id}`,
98
+ method: 'delete'
99
+ })
100
+ }
101
+
102
+ /**
103
+ * 批量删除用户权限配置
104
+ * @param {Array} ids - 删除的用户权限配置ids。
105
+ * @returns {number} code - 返回码,0表示成功
106
+ */
107
+ export function deleteMany(ids) {
108
+ return requestShow({
109
+ url: '/user-devices',
110
+ method: 'delete',
111
+ data: ids // delete传递主体要包含在data里
112
+ })
113
+ }
114
+
115
+ export default {
116
+ list,
117
+ create,
118
+ updateOne,
119
+ deleteOne,
120
+ deleteMany
121
+ }
122
+
package/api/view.js ADDED
@@ -0,0 +1,122 @@
1
+ import { requestShow } from '../utils'
2
+ /**
3
+ * @file 看板页面api
4
+ * @module 看板页面接口
5
+ */
6
+
7
+
8
+ /**
9
+ * 页面类型type
10
+ * @readonly
11
+ * @enum {string}
12
+ */
13
+ var type = {
14
+ 基础: 'base',
15
+ 设备UI: 'layoutDevicePanel',
16
+ 摄像头: 'videosPanel'
17
+ }
18
+
19
+ /**
20
+ * UI类型uiType
21
+ * @readonly
22
+ * @enum {string}
23
+ */
24
+ var uiType = {
25
+ UI模型: 'uiModel',
26
+ UI组件: 'uiComponent',
27
+ }
28
+
29
+ /**
30
+ * @typedef {Object} view页面
31
+ * @property {string} _id - 看板页面id.
32
+ * @property {string} path - 页面路径.
33
+ * @property {string} type - 页面类型查看枚举type.
34
+ * @property {boolean} decode - 页面是否已独立解构默认为false.
35
+ * @property {object} attrs - 每个页面的自定义属性.
36
+ * @property {string} attrs.deviceClass - 页面关联的设备类型.
37
+ * @property {number} attrs.scale - 页面设备UI的缩放等级.
38
+ * @property {Array} attrs.scenes - 页面下关联的定时场景id同IOT的定时场景.
39
+ * @property {Array} attrs.smarts - 页面下关联的智能场景id同IOT的智能场景.
40
+ * @property {string} attrs.uiType - 页面下关联的UI类型查看枚举uiType.
41
+ * @property {string} attrs.uimodel - 页面下关联的UI模型id.
42
+ */
43
+
44
+
45
+ /**
46
+ *
47
+ * @param {*} query
48
+ * @param {number} query.page - 页码
49
+ * @param {number} query.limit - 每页数量
50
+ * @returns {number} code - 返回码,0表示成功
51
+ * @returns {number} total - 页面总数
52
+ * @returns {Array} rows - 页面数组查看数据定义
53
+ */
54
+ export function list(query) {
55
+ return requestShow({
56
+ url: '/views',
57
+ method: 'get',
58
+ params: query
59
+ })
60
+ }
61
+
62
+ /**
63
+ * 新增页面
64
+ * @param {Object} data - 包含页面的请求体 属性见list返回字段。
65
+ * @returns {number} code - 返回码,0表示成功
66
+ * @returns {string} data - 新增成功的数据 跟list返回字段一致
67
+ */
68
+ export function create(data) {
69
+ return requestShow({
70
+ url: '/views',
71
+ method: 'post',
72
+ data
73
+ })
74
+ }
75
+
76
+ /**
77
+ * 修改页面
78
+ * @param {Object} data - 包含页面的请求体 属性见list返回字段。
79
+ * @returns {number} code - 返回码,0表示成功
80
+ * @returns {string} data - 修改成功的数据 跟list返回字段一致
81
+ */
82
+ export function updateOne(data) {
83
+ return requestShow({
84
+ url: `/views/${data._id}`,
85
+ method: 'put',
86
+ data
87
+ })
88
+ }
89
+ /**
90
+ * 删除页面
91
+ * @param {string} id - 删除的页面id。
92
+ * @returns {number} code - 返回码,0表示成功
93
+ * @returns {string} data - 删除成功的数据 跟list返回字段一致
94
+ */
95
+ export function deleteOne(id) {
96
+ return requestShow({
97
+ url: `/views/${id}`,
98
+ method: 'delete'
99
+ })
100
+ }
101
+
102
+ /**
103
+ * 批量删除页面
104
+ * @param {Array} ids - 删除的页面ids。
105
+ * @returns {number} code - 返回码,0表示成功
106
+ */
107
+ export function deleteMany(ids) {
108
+ return requestShow({
109
+ url: '/views',
110
+ method: 'delete',
111
+ data: ids // delete传递主体要包含在data里
112
+ })
113
+ }
114
+
115
+ export default {
116
+ list,
117
+ create,
118
+ updateOne,
119
+ deleteOne,
120
+ deleteMany
121
+ }
122
+
package/index.js CHANGED
@@ -10,6 +10,15 @@ import bmsRole from './api/bmsRole'
10
10
  import bmsRouter from './api/bmsRouter'
11
11
  import devices from './api/devices'
12
12
  import deviceClass from './api/deviceClass'
13
+ import tag from './api/tag'
14
+ import svglib from './api/svglib'
15
+ import relationPlatform from './api/relationPlatform'
16
+ import components from './api/components'
17
+ import application from './api/application'
18
+ import upload from './api/upload'
19
+ import appRouter from './api/appRouter'
20
+ import view from './api/view'
21
+ import userDevice from './api/userDevice'
13
22
  const api = {
14
23
  alarmRecord,
15
24
  alarmProgress,
@@ -19,14 +28,25 @@ const api = {
19
28
  bmsRole,
20
29
  bmsRouter,
21
30
  devices,
22
- deviceClass
31
+ deviceClass,
32
+ tag,
33
+ svglib,
34
+ relationPlatform,
35
+ components,
36
+ application,
37
+ upload,
38
+ appRouter,
39
+ view,
40
+ userDevice
23
41
  }
24
42
 
25
- export default { config: options => {
26
- Object.assign(config, options)
27
- init()
28
- },
29
- on: (...args) => {
30
- emitter.on(...args)
31
- },
32
- ...api }
43
+ export default {
44
+ config: options => {
45
+ Object.assign(config, options)
46
+ init()
47
+ },
48
+ on: (...args) => {
49
+ emitter.on(...args)
50
+ },
51
+ ...api
52
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "nayota-show-sdk",
3
- "version": "0.1.3",
3
+ "version": "1.0.0",
4
4
  "description": "nayota-show-server rest-api",
5
5
  "type": "module",
6
6
  "main": "index.js",