nayota-show-sdk 1.3.8 → 1.3.10

package/api/application.js

@@ -14,6 +14,7 @@ import { requestShow } from '../utils'
  * @property {string} color - 图标颜色
  * @property {number} type - 应用类型，取value值[{name: '本地应用', value: 0}, {name: '平台应用', value: 1}]
  * @property {string} url - 应用路径
+ * @property {string} relationPlatform - 关联平台
  * @example
  * {
     "_id": "6565849e55f4e0b6dd126f5e",

package/api/datavDatas.js

@@ -0,0 +1,97 @@
+import { requestCf as request } from '../utils'
+
+/**
+ * @file 自定义表单数据
+ * @module 自定义表单数据
+ * @memberof requestEnergy
+ * @category 系统设置
+ * @categoryOrder 8 
+ * @import
+ * import SDK from 'nayota-show-sdk' 
+ * export const { list, create, getOne, updateOne, deleteOne, deleteMany } = SDK.datavDatas
+ */
+
+/**
+ * @typedef {Object} DatavData
+ * @property {string} _id - 主键ID
+ * @property {string} name - 名称
+ * @property {string} formDataStr - 表单数据
+ * @property {string} datavForm - 表单类型
+ * @property {string} creator - 创建者
+ * @property {Date} createdAt - 创建时间
+ * @property {Date} updatedAt - 更新时间
+ */
+
+/**
+ * 获取自定义表单数据列表
+ * @param {Object} query - 请求数据.
+ * @param {string} query.label - 查询的字段名，如：name.
+ * @param {string} query.search - 查询的字段值，支持模糊查询，如：定时打开.
+ * @param {string} query.page - 分页第几页，指从哪开始查.
+ * @param {number} query.limit - 单页数据，指一次查几条.
+ * @param {string} query.select - 只查询部分字段，如：name id.
+ * @returns {Object} code 是否成功.
+ * @returns {object} data - 返回数据.
+ * @returns {number} data.total - 总数.
+ * @returns {object} data.rows - 数据. 属性见@typedef {Object} DatavData
+ */
+export function list(query) {
+  return request({
+    url: '/datav-datas',
+    method: 'get',
+    params: query
+  })
+}
+
+export function getInfo(query) {
+  return request({
+    url: '/datav-datas/get-info',
+    method: 'get',
+    params: query
+  })
+}
+
+export function getOne(id) {
+  return request({
+    url: `/datav-datas/${id}`,
+    method: 'get'
+  })
+}
+
+export function create(data) {
+  return request({
+    url: '/datav-datas',
+    method: 'post',
+    data
+  })
+}
+
+export function updateOne(data) {
+  return request({
+    url: `/datav-datas/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+
+export function deleteOne(id) {
+  return request({
+    url: `/datav-datas/${id}`,
+    method: 'delete'
+  })
+}
+
+export function deleteMany(ids) {
+  return request({
+    url: '/datav-datas',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}
+export function submitDatavData(data) {
+  return request({
+    url: '/datav-datas/submit',
+    method: 'post',
+    data
+  })
+}

package/api/datavForms.js

@@ -0,0 +1,95 @@
+import { requestCf as request } from '../utils'
+/**
+ * @file  第三方配置.
+ * @module 第三方配置
+ * @memberof requestEnergy
+ * @category 系统设置
+ * @import
+ * import SDK from 'nayota-cfg-sdk' 
+ * export const { list, create, getOne, updateOne, deleteOne, deleteMany } = SDK.datavForms
+ */
+
+/**
+ * @typedef {Object} DatavForm
+ * @property {string} _id - 主键ID
+ * @property {string} name - 名称
+ * @property {string} code - 编码
+ * @property {string} note - 备注
+ * @property {string} formJsonStr - 表单json数据字符串
+ * @property {string} formFunStr - 表单json数据转换方法字符串
+ * @property {number} sort - 排序
+ * @property {Date} createdAt - 创建时间
+ * @property {Date} updatedAt - 更新时间
+ * @property {string} creator - 创建者
+ */ 
+
+/**
+ * 获取通用配置列表。
+ * @param {Object} data - 请求数据.
+ * @param {string} data.label - 查询的字段名，如：name.
+ * @param {string} data.search - 查询的字段值，支持模糊查询，如：定时打开.
+ * @param {string} data.page - 分页第几页，指从哪开始查.
+ * @param {number} data.limit - 单页数据，指一次查几条.
+ * @param {string} data.select - 只查询部分字段，如：name id.
+ * @returns {Object} code 是否成功.
+ * @returns {object} data - 返回数据.
+ * @returns {number} data.total - 总数.
+ * @returns {object} data.rows - 数据. 属性见@typedef {Object} DatavForm
+ */
+export function list(query) {
+  return request({
+    url: '/datav-forms',
+    method: 'get',
+    params: query
+  })
+}
+/**
+ * 新增通用配置
+ * @param {Object} data - 包含通用配置的请求体 
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 新增成功的数据
+ */
+export function create(data) {
+  return request({
+    url: '/datav-forms',
+    method: 'post',
+    data
+  })
+}
+/**
+ * 修改通用配置
+ * @param {Object} data - 包含通用配置的请求体 
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 修改成功的数据
+ */
+export function updateOne(data) {
+  return request({
+    url: `/datav-forms/${data._id}`,
+    method: 'put',
+    data
+  })
+}
+/**
+ * 删除通用配置
+ * @param {string} id - 删除通用配置的id。
+ * @returns {number} code - 返回码，0表示成功
+ * @returns {string} data - 删除成功的数据
+ */
+export function deleteOne(id) {
+  return request({
+    url: `/datav-forms/${id}`,
+    method: 'delete'
+  })
+}
+/**
+ * 批量删除通用配置
+ * @param {Array} ids - 删除的通用配置ids。
+ * @returns {number} code - 返回码，0表示成功
+ */
+export function deleteMany(ids) {
+  return request({
+    url: '/datav-forms',
+    method: 'delete',
+    data: ids // delete传递主体要包含在data里
+  })
+}

package/api/devices.js

@@ -210,7 +210,15 @@ export function deleteMany(ids) {
  * 删除所有平台设备
  * @param {Object} query - 删除对象。
  * @param {Array} query.ids - 删除的设备ids。
+ * @example
+ * {
+ *   "ids": ["667d2efa52d21700095b58d5"]
+ * }
  * @returns {number} code - 返回码，0表示成功
+ * @example
+ * {
+ *   "code": 0
+ * }
  */
 export function deleteAllDevice(query) {
   return requestShow({

package/api/userDevice.js

@@ -22,6 +22,7 @@ import { requestShow } from '../utils'
  * @property {string} introduction - 整体介绍.
  * @property {number} buildingArea - 楼宇占地面积.
  * @property {number} averageArea - 面均面积.
+ * @property {boolean} dynamicPath - 动态链接.
  * @example
  * {
     "devices": [],

package/package.json

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