super-page-runtime 1.0.12 → 1.0.14

package/src/components/runtime/utils/interfaces/page-design-types.ts

@@ -0,0 +1,259 @@
+/**
+ * 状态
+ */
+export enum EnableStates {
+  ENABLE = 'ENABLE',
+  DISABLE = 'DISABLE'
+}
+
+/**
+ * 屏幕尺寸
+ */
+export enum PageDimensions {
+  //大屏
+  PC = 'pc',
+  //平板
+  IPAD = 'ipad',
+  //手机 小屏
+  PHONE = 'phone'
+}
+
+/**
+ * 组件对象
+ */
+export interface Component extends Object {
+  uuid: string //动态生成的惟一编码
+  name: string //组件名称/类型
+  label: string //不能为空
+  //详细描述
+  desc?: string
+  icon?: string //图标
+  //版本
+  version?: number
+  releaseDate?: string //发布日期
+  //创建人
+  creator?: string
+  //审核人
+  auditor?: string
+  //缩略图
+  snapshot?: string
+  //文档地址
+  docHref?: string
+  //父级
+  parent?: Component
+  //子级
+  items?: Component[]
+  //组件配置的属性
+  props?: any
+  //配置的样式信息
+  style?: any
+  //事件对象
+  events?: ComponentEvent[]
+  methods?: ComponentMethod[]
+  //定义高级属性
+  advance?: any
+  [otherProp: string]: any
+}
+
+/**
+ * 页面对象
+ */
+export interface PageDesign extends Component {
+  systemCode: string //应用代码
+  systemVersion: number //应用版本
+  code: string //页面代码
+  version: number //页面版本
+  tableSysCode?: string //表所属应用代码
+  tableSysVersion?: number //表所属应用版本
+  tableName?: string //数据表名称
+  tableAlias?: string //表别名，用于显示
+  workflowCode: string //工作流定义编码
+  workflowVersion: number //工作流定义版本
+  //页面自定义变量
+  variables?: CustomVariable[]
+  //前端逻辑集合
+  logicDesigns?: object[]
+  //数据模型
+  modelFields?: ModelField[]
+  //tableInfos?:Array<any>,//页面中所有表格的集合，用于缓存表格的配置信息
+  rules?: object // 表单验证规则
+  tableUuids?: Array<any> // 表格uuid集合
+  tableNames?: Array<any> // 当前页面中表格对应的数据表名集合，后台保存子表记录时需要
+  formNoRuleCode?: string // 表单编号规则
+  judgeHeavyList?: Array<any> // 判重组合字段集合配置
+  conversionCodes?: Array<any> // 数据转换规则
+  pageType?: string // 页面类型：form、list、chart
+  beanName?: string // 业务处理类，继承CommonBaseService接口的类
+  importBeanName?: string // 导入处理类，继承ImportDefinitionService接口的类
+  name: string //页面名称
+  notIdInitializationList?: Array<any> // 无ID或taskId时初始条件配置
+  subTablePageInfo?: object // 列表分页信息，格式是：{列表编码: 每页显示多少条记录}，表单页面中校验有分页的子表时提示使用，提示信息格式：第 {pageNum} 页第 {row} 行记录
+  customValidatorUuids?: Array<string> // 自定义组件启用了“自定义校验”开关的uuid集合
+  customEvents?: Array<any> // 页面事件集合
+}
+
+/**
+ * 运行时页面对象
+ */
+export interface PageContext extends Component {
+  isTest?: boolean //是否测试,测试时功能权限不控制
+  systemCode?: string //应用代码
+  systemVersion?: number //应用版本
+  code: string //页面代码
+  version: number //页面版本
+  dimensions: string //页面尺寸
+  tableSysCode?: string //表所属应用代码
+  tableSysVersion?: number //表所属应用版本
+  tableName?: string //数据表名称
+  tableAlias?: string //表别名，用于显示
+  workflowCode?: string //工作流定义编码
+  workflowVersion?: number //工作流定义版本
+  rules?: object // 表单验证规则
+  tableUuids?: Array<any> // 表格uuid集合
+  tableNames?: Array<any> // 当前页面中表格对应的数据表名集合，后台保存子表记录时需要
+  formNoRuleCode?: string // 表单编号规则
+  judgeHeavyList?: Array<any> // 判重组合字段集合配置
+  conversionCodes?: Array<any> // 数据转换规则
+  pageType?: string // 页面类型：form、list、chart
+  beanName?: string // 业务处理类，继承CommonBaseService接口的类
+  importBeanName?: string // 导入处理类，继承ImportDefinitionService接口的类
+  name: string //页面名称
+  notIdInitializationList?: Array<any> // 无ID或taskId时初始条件配置
+  subTablePageInfo?: object // 列表分页信息，格式是：{列表编码: 每页显示多少条记录}，表单页面中校验有分页的子表时提示使用，提示信息格式：第 {pageNum} 页第 {row} 行记录
+  customValidatorUuids?: Array<string> // 自定义组件启用了“自定义校验”开关的uuid集合
+  entity: {
+    data: {
+      [otherProp: string]: any
+    }
+    task: {
+      [otherProp: string]: any
+    }
+    request: {
+      [otherProp: string]: any
+    }
+    page: {
+      [otherProp: string]: any
+    }
+    context: {
+      [otherProp: string]: any
+    }
+    system: {
+      [otherProp: string]: any
+    }
+  }
+  superGridItems?: object // 列表配置信息，根据table configur获得的SuperGrid DTO信息，预览时需要使用
+  emailTemplateCode?: string //流程处理时使用。流程办理时发送邮件的邮件模板
+  fieldPermissions?: Array<any> // 表单字段的编辑权限信息
+  fieldPermissionMap?: Map<string, any> // 表单字段编辑权限的map集合，key是属性名，value是校验信息
+  actionPermissions?: Array<any> // 表单子表操作的权限信息：新增、修改、删除,key为子表名称或model名称,value为该子表的操作权限信息
+  actionPermissionMap?: Map<string, any> // 表单子表编辑权限的map集合，key是子表属性名，value是校验信息
+  workflowButtonComponent?: object // 流程按钮组件需要的信息
+  completeTaskParam?: object // 流程处理时使用。进入表单页面时需要的信息，例如：字段权限、按钮信息等等。firstNodeInfo=completeTaskParam.firstNodeInfo
+  customRules?: object // 自定义验证规则,脚本动态控制字段必填和禁止编辑使用
+  initFormNo?: string // 初始表单页面时生成的表单编码，例如：Gyssh202405200277
+  definitionId?: number // 流程定义id
+  dataTypeMaps?: Object // 数据表字段map集合，key是tableName，value是该表的字段集合map
+  editData?: object // 表格行编辑时当前编辑的数据data
+  searchFormData?: Array<object> // 自定义组件中修改查询条件
+  selectOptions?: object // 子表下拉选组件集合，导出报告使用，key是子表字段名，value是下拉选集合
+  [otherProp: string]: any
+}
+
+/**
+ * 事件对象
+ */
+export interface ComponentEvent extends Object {
+  name: string //事件名称
+  label: string //显示名称
+  params?: ComponentEventParam[]
+}
+
+/**
+ * 事件对象
+ */
+export interface ComponentEventParam extends Object {
+  //参数名
+  name: string
+  //显示名称
+  label: string
+  //参数类型
+  type: string
+}
+
+/**
+ * 方法对象
+ */
+export interface ComponentMethod extends Object {
+  name: string //方法名称
+  label: string //显示名称
+  //入参
+  inParams: ComponentEventParam[]
+  //出参
+  outParams: ComponentEventParam[]
+}
+
+/**
+ * 方法参数描述
+ */
+export interface ComponentMethodParam extends Object {
+  //参数名
+  name: string
+  //参数类型
+  type: string
+}
+
+/**
+ * 自定义变量对象
+ */
+export interface CustomVariable extends Object {
+  name: string //变量名称
+  alias: string //显示名称
+  defaultValue?: string //默认值
+  isArrayElement?: boolean //是否集合的固定子节点
+  items?: CustomVariable[]
+  [otherProp: string]: any
+}
+
+/**
+ * 自定义变量对象
+ */
+export interface ModelField extends Object {
+  name: string //字段名称
+  alias: string //字段别名
+  dataType: string //字段类型
+  displayOrder: number //排序
+}
+
+/**
+ * 前端逻辑对象
+ */
+export interface LogicDesign extends Object {
+  code: string //编码
+  name: string //名称
+  props?: any //配置属性
+  variables?: CustomVariable[]
+  flow: {
+    nodes?: LogicNode[]
+  }
+  triggerSource?: LogicTriggerSource[]
+}
+/**
+ * 前端逻辑节点对象
+ */
+export interface LogicNode extends Object {
+  id: string //随机生成,惟一
+  type: string //节点类型
+  x: number //位置
+  y: number //位置
+  properties?: any //配置属性
+}
+
+/**
+ * 前端逻辑节点触发来源
+ */
+export interface LogicTriggerSource extends Object {
+  assemblyIndex: number //组件的ID
+  assemblyType: string //组件类型
+  triggerType: string //触发类型 如 method,event
+  triggerName: string //名称,如change
+}