@gct-paas/schema 0.1.4-dev.8 → 0.1.5-dev.0

package/es/interface/design/i-design-node-data.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 设计节点数据
+ *
+ * @author zhanghanrui
+ * @date 2024-07-09 16:07:29
+ * @export
+ * @interface IDesignNodeData
+ */
+export interface IDesignNodeData {
+    [key: string | symbol]: any;
+    /**
+     * 设计节点名称
+     *
+     * @author zhanghanrui
+     * @date 2024-07-12 11:07:05
+     * @type {string}
+     */
+    name?: string;
+}

package/es/interface/design/i-design-node.d.ts

@@ -0,0 +1,80 @@
+import { IDesignNodeData } from './i-design-node-data';
+/**
+ * 设计节点
+ *
+ * @author zhanghanrui
+ * @date 2024-07-09 16:07:21
+ * @export
+ * @interface IDesignNode
+ * @template T
+ */
+export interface IDesignNode<T extends IDesignNodeData = IDesignNodeData> {
+    /**
+     * 节点唯一标识
+     *
+     * @author zhanghanrui
+     * @date 2024-07-05 13:07:46
+     * @type {string}
+     */
+    id: string;
+    /**
+     * 排序值
+     * 2024年8月23日15:10:19 - 改版后 order 不再使用
+     *
+     * @deprecated
+     * @author zhanghanrui
+     * @date 2024-07-12 14:07:40
+     * @type {number}
+     */
+    order?: number;
+    /**
+     * 名称
+     *
+     * @author zhanghanrui
+     * @date 2024-07-05 15:07:37
+     * @type {string}
+     */
+    label: string;
+    /**
+     * 节点类型
+     *
+     * @author zhanghanrui
+     * @date 2024-07-05 13:07:46
+     * @type {string}
+     */
+    type: string;
+    /**
+     * 数据更新时间戳
+     *
+     * @author zhanghanrui
+     * @date 2024-07-05 17:07:02
+     * @type {number}
+     */
+    updateDate: number;
+    /**
+     * 设计项的数据
+     *
+     * @author zhanghanrui
+     * @date 2024-07-09 16:07:47
+     * @type {T}
+     */
+    data: T;
+    /**
+     * 父节点标识
+     * 2024年8月23日15:10:19 - 改版后 parentId 不再使用
+     *
+     * @deprecated
+     * @author zhanghanrui
+     * @date 2024-07-05 13:07:38
+     * @type {string}
+     */
+    parentId?: string;
+    /**
+     * 克隆
+     *
+     * @author zhanghanrui
+     * @date 2024-07-12 13:07:44
+     * @return {*}  {IDesignNode}
+     */
+    clone(): IDesignNode;
+}

package/es/interface/design/i-design-page-node-data.d.ts

@@ -0,0 +1,15 @@
+import { IDesignNodeData } from './i-design-node-data';
+/**
+ * 设计界面节点
+ *
+ * @author zhanghanrui
+ * @date 2024-07-24 10:07:27
+ * @export
+ * @interface IDesignPageNode
+ * @extends {IDesignNode}
+ */
+export interface IDesignPageNodeData extends IDesignNodeData {
+    background: string;
+    padding: string;
+    headerBgColor?: boolean;
+}

package/es/interface/design/i-design-tree-item.d.ts

@@ -0,0 +1,26 @@
+/**
+ * 设计树项
+ *
+ * @author zhanghanrui
+ * @date 2024-08-20 10:08:36
+ * @export
+ * @interface IDesignTreeItem
+ */
+export interface IDesignTreeItem {
+    /**
+     * 标识
+     *
+     * @author zhanghanrui
+     * @date 2024-08-20 10:08:48
+     * @type {string}
+     */
+    id: string;
+    /**
+     * 子项
+     *
+     * @author zhanghanrui
+     * @date 2024-08-20 10:08:56
+     * @type {IDesignTreeItem[]}
+     */
+    children?: IDesignTreeItem[];
+}

package/es/interface/design/i-drag-data-item.d.ts

@@ -0,0 +1,46 @@
+import { IDesignNode } from './i-design-node';
+/**
+ * 拖拽数据项
+ *
+ * @export
+ * @interface IDragDataItem
+ * @template O
+ */
+export interface IDragDataItem<O extends IDesignNode = IDesignNode> {
+    /**
+     * 当前数据标识，如果是新数据则主键为空
+     *
+     * @type {string}
+     */
+    id: string;
+    /**
+     * 拖拽分组实例标识
+     *
+     * @type {string}
+     */
+    group: string;
+    /**
+     * 拖拽项原位置索引
+     *
+     * @type {number}
+     */
+    index: number;
+    /**
+     * 当前拖拽数据
+     *
+     * @type {O}
+     */
+    data: O;
+    /**
+     * 数据模式
+     *
+     * @type {('create' | 'move')} 新建 | 移动
+     */
+    mode: 'create' | 'move';
+    /**
+     * 包含自身 + 所有子的类型，目前主要用于拖拽限制
+     *
+     * @type {string[]}
+     */
+    types: string[];
+}

package/es/interface/design/index.d.ts

@@ -0,0 +1,9 @@
+export type { IDesignContainerNode } from './i-design-container-node';
+export type { IDesignPageNodeData } from './i-design-page-node-data';
+export type { IDesignData } from './i-design-data';
+export type { IDesignEditorData } from './i-design-editor-data';
+export type { IDesignEditorNode } from './i-design-editor-node';
+export type { IDesignNodeData } from './i-design-node-data';
+export type { IDesignNode } from './i-design-node';
+export type { IDesignTreeItem } from './i-design-tree-item';
+export type { IDragDataItem } from './i-drag-data-item';

package/es/interface/designer.d.ts

@@ -1,6 +1,12 @@
 import { pageLayoutModeEnum } from '@gct-paas/core';
 import { LowCodeModal } from './modal';
 import { LowCodeWidget } from './widget';
+export interface IPageGlobalEvents {
+    /**页面加载公共事件ID */
+    pageMounted?: string;
+    /**页面离开公共事件ID */
+    pageDestroyed?: string;
+}
 export interface PageJson {
     id: string;
     key?: string;
@@ -13,20 +19,15 @@ export interface PageJson {
         pageMounted?: LowCodeWidget.JsEvent | LowCodeWidget.InnerEvents[];
         /**页面离开事件 */
         pageDestroyed?: LowCodeWidget.JsEvent | LowCodeWidget.InnerEvents[];
+        pageActivated?: LowCodeWidget.JsEvent | LowCodeWidget.InnerEvents[];
     };
     widgets: LowCodeWidget.BasicSchema[];
     js: string;
     css: string;
     modals: LowCodeModal.Modal[];
     timestamp?: number;
-    newDesigner?: boolean;
     /**全局页面事件 */
-    globalEvents: {
-        /**页面加载公共事件ID */
-        pageMounted?: string;
-        /**页面离开公共事件ID */
-        pageDestroyed?: string;
-    };
+    globalEvents: IPageGlobalEvents;
     permissions: Record<string, string | null>;
     style: Partial<LowCodeWidget.BasicStyle>;
     pageConfig: Partial<PageConfig>;

package/es/interface/index.d.ts

@@ -1,3 +1,8 @@
-export * from './designer';
-export * from './modal';
+export type { LinkageItem } from './common/data-linkage-config';
+export type * from './modal';
+export type * from './schema';
 export type * from './widget';
+export type * from './widget-info';
+export type * from './designer';
+export type * from './relationship-diagram-config';
+export type * from './design';

package/es/interface/modal/i-modal-body.d.ts

@@ -9,7 +9,7 @@ export interface IModalBody {
     /** 唯一标识 */
     id: string;
     /** 组件类型 */
-    type: BuiltinType.MODAL_BODY;
+    type: BuiltinType.MODAL_BODY | string;
     /** 子组件列表 */
     children: LowCodeWidget.BasicSchema[];
 }

package/es/interface/modal/i-modal.d.ts

@@ -32,7 +32,7 @@ export interface IModal {
     /** CSS 样式代码 */
     css: string;
     /** 子组件：主体、底部、底部按钮容器 */
-    children: [IModalBody, IModalFooter, IModalBottomButton];
+    children: [IModalBody, IModalFooter, IModalBottomButton?];
     /** 模态框属性配置 */
     props: IModalProps;
     /** 事件配置 */

package/es/interface/relationship-diagram-config/i-relationship-diagram-node.d.ts

@@ -0,0 +1,82 @@
+/**
+ * 节点
+ *
+ * @author zhanghanrui
+ * @date 2024-06-25 10:06:53
+ * @export
+ * @interface IRelationshipDiagramNode
+ */
+export interface IRelationshipDiagramNode {
+    /**
+     * 节点唯一标识
+     *
+     * @author zhanghanrui
+     * @date 2024-06-25 13:06:35
+     * @type {string}
+     */
+    id: string;
+    /**
+     * 字段唯一标识
+     *
+     * @author zhanghanrui
+     * @date 2024-07-05 10:07:11
+     * @type {string | null}
+     */
+    id_: string | null;
+    /**
+     * 节点类型
+     *
+     * @author zhanghanrui
+     * @date 2024-06-25 13:06:44
+     * @type {string}
+     */
+    type: string;
+    /**
+     * 当前模型标识
+     *
+     * @author zhanghanrui
+     * @date 2024-06-26 16:06:15
+     * @type {string | null}
+     */
+    modelKey: string | null;
+    /**
+     * 模型类型
+     *
+     * @author zhanghanrui
+     * @date 2024-06-26 16:06:30
+     * @type {string | null}
+     */
+    modelCategory: string | null;
+    /**
+     * 属性key
+     *
+     * @author zhanghanrui
+     * @date 2024-06-26 16:06:46
+     * @type {string | null}
+     */
+    value: string | null;
+    /**
+     * 属性文本
+     *
+     * @author zhanghanrui
+     * @date 2024-06-26 16:06:56
+     * @type {string | null}
+     */
+    label: string | null;
+    /**
+     * 是否为反向节点
+     *
+     * @author zhanghanrui
+     * @date 2024-06-28 15:06:46
+     * @type {boolean}
+     */
+    reverse?: boolean;
+    /**
+     * 禁止选择属性
+     *
+     * @author zhanghanrui
+     * @date 2024-06-28 13:06:52
+     * @type {boolean}
+     */
+    noSelectField?: boolean;
+}

package/es/interface/relationship-diagram-config/i-rule-config.d.ts

@@ -0,0 +1,135 @@
+import { IRelationshipDiagramNode } from './i-relationship-diagram-node';
+/**
+ * 设计 json
+ *
+ * @author zhanghanrui
+ * @date 2024-06-29 17:06:51
+ * @export
+ * @interface IDesignJson
+ */
+export interface IDesignJson {
+    /**
+     * 前置信息
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:58
+     * @type {IData}
+     */
+    before?: IData;
+    /**
+     * 节点信息
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:10
+     * @type {IRelationshipDiagramNode[]}
+     */
+    nodes: IRelationshipDiagramNode[];
+    /**
+     * 后置信息
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:08
+     * @type {IData}
+     */
+    after?: IData;
+}
+export interface INodeData {
+    /**
+     * 模型标识
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:38
+     * @type {string}
+     */
+    modelKey: string;
+    /**
+     * 模型类型
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:06
+     * @type {string}
+     */
+    modelCategory: string;
+    /**
+     * 属性标识
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:42
+     * @type {string}
+     */
+    fieldKey: string;
+    /**
+     * 节点方向
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:47
+     * @type {('forward' | 'backward' | '')}
+     */
+    direction: 'forward' | 'backward' | '';
+}
+/**
+ * 数据联动 ruleConfig 配置清单
+ *
+ * @author zhanghanrui
+ * @date 2024-06-29 17:06:29
+ * @export
+ * @interface IRuleConfig
+ */
+export interface IRuleConfig {
+    /**
+     * 设计 json 配置
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:31
+     * @type {IDesignJson}
+     */
+    designJson: IDesignJson;
+    /**
+     * 是否强依赖
+     *
+     * @author zhanghanrui
+     * @date 2024-09-02 15:09:15
+     * @type {boolean}
+     */
+    strongDependence: boolean;
+    /**
+     * 主查字段名称
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 19:06:48
+     * @type {string}
+     */
+    modelKey: string;
+    /**
+     * 属性标识（不是所有场景都有）
+     *
+     * @author zhanghanrui
+     * @date 2024-07-05 11:07:25
+     * @type {string}
+     */
+    fieldId?: string;
+    /**
+     * 属性标识（不是所有场景都有）
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:47
+     * @type {string}
+     */
+    fieldKey?: string;
+    /**
+     * 属性名称
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 19:06:24
+     * @type {string}
+     */
+    fieldLabel?: string;
+    /**
+     * 给后台使用的 nodes 清单
+     *
+     * @author zhanghanrui
+     * @date 2024-06-29 17:06:41
+     * @type {INodeData[]}
+     */
+    nodes: INodeData[];
+}

package/es/interface/relationship-diagram-config/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './i-relationship-diagram-node';
+export type * from './i-rule-config';

package/es/interface/schema/index.d.ts

@@ -0,0 +1,2 @@
+export type * from './widget-props';
+export type * from './widget-types';

package/es/interface/schema/widget-props/i-button-props.d.ts

@@ -0,0 +1,170 @@
+import { ButtonColorType, ButtonColorTheme, ButtonStyle, ButtonSize, AGLINE_ENUMS, operateSysEnums, PrintModeEnums, TransactionMode, KeyMode, ResetRuleType, ButtonOpeEnum, openWindowEnums, ButtonTypeEnum } from '@gct-paas/core';
+import { LowCodeWidget } from '../..';
+/** 按钮基础通用属性（不含 WidgetProps，用于 ButtonProps.basic） */
+export interface ButtonBasicProps {
+    disabled: boolean;
+    buttonTheme: ButtonColorTheme;
+    buttonType: ButtonColorType;
+    icon: string;
+    iconColor: string;
+    /** 按钮样式 */
+    buttonStyle: ButtonStyle;
+    /** 开启二次确认 */
+    confirm: boolean;
+    /** 二次确认内容 */
+    confirmText: string;
+    enableCustomColor: boolean;
+    backgroundColor: string;
+    fontColor: string;
+}
+/** 基础按钮属性（所有按钮类的共同基类） */
+export interface BaseButtonProps extends LowCodeWidget.WidgetProps {
+    /** 关联表单 */
+    refForm?: string;
+    /** 关联弹框 */
+    refModal?: string;
+    /** 关联列表 */
+    refList?: string;
+    /** 标题 */
+    title: string;
+    /** 二次确认 */
+    confirm?: boolean;
+    confirmText?: string;
+    /** 内置事件 */
+    innerEvent?: boolean;
+    /** 系统事件类型 */
+    sysMethedType?: operateSysEnums;
+    linkPage?: string;
+    /** 事件名称 */
+    eventName?: string;
+    icon: string;
+    iconColor: string;
+    size: ButtonSize;
+    disabled: boolean;
+    /** 是否显示按钮名称 */
+    hasText: boolean;
+    /** 是否显示图标 */
+    hasIcon: boolean;
+    /** 按钮 type */
+    type: string;
+    /** 是否是危险类型 */
+    danger: boolean;
+    /** 关联模型 */
+    model?: string;
+    i18nConfig?: string;
+    /** 按钮样式 */
+    buttonStyle?: ButtonStyle;
+    enableCustomColor: boolean;
+    backgroundColor?: string;
+    fontColor?: string;
+    /** 复制按钮需要排除的字段 */
+    excludeField?: string[];
+    /** 按钮所在位置 */
+    pos?: ButtonOpeEnum;
+    /** 将当前按钮的名称同步为弹框标题 */
+    syncBtnNameToModal?: boolean;
+}
+/** 普通按钮（带 basic 配置）属性 */
+export interface ButtonProps extends LowCodeWidget.WidgetProps {
+    title: string;
+    /** 关联表单 */
+    refForm?: string;
+    /** 关联列表 */
+    refList?: string;
+    basic: ButtonBasicProps;
+}
+/** 流程提交按钮属性 */
+export interface ProcessButtonProps extends BaseButtonProps {
+    refModel?: string;
+    category?: string;
+    refProcess?: string;
+    refService?: string;
+}
+/** 审批按钮属性 */
+export interface approveButtonProps extends BaseButtonProps {
+    action?: ButtonTypeEnum;
+    /** 不可删除 */
+    noDelete: boolean;
+    /** 不可编辑 */
+    noEdit: boolean;
+    processId: string;
+    refForm: string;
+}
+/** 重置按钮属性 */
+export interface ResetButtonProps extends BaseButtonProps {
+    resetRule: ResetRuleType;
+}
+/** 表格审批按钮属性 */
+export interface TableApproveButtonProps extends BaseButtonProps {
+    /** 打开方式 */
+    openType: openWindowEnums;
+}
+/** 标签打印按钮属性 */
+export interface LabelPrintProps extends BaseButtonProps {
+    /** 打印方式 */
+    printMode: PrintModeEnums;
+    /** 打印模版 key 或者模版的引用类型 */
+    printKey: string | TransactionMode;
+    /** 打印服务 key */
+    serverKey: string;
+    /** 关联模型 */
+    refModel: string;
+    /** 标签模版类型 */
+    labelMode: KeyMode;
+    /** 打印机类型 */
+    printType: KeyMode;
+    /** 打印 key */
+    printVal: string;
+    /** 网络打印机类型 或者打印机 id */
+    printRefType: string | TransactionMode;
+    /** 引用关系配置 */
+    ruleConfig: IObject;
+    /** 打印机的关联配置 */
+    printRuleConfig: IObject;
+    /** 打印字段 */
+    printField?: string;
+    /** 关联的表单 */
+    refForm?: string;
+}
+/** 单据打印按钮属性 */
+export interface DocumentPrintProps extends BaseButtonProps {
+    /** 单据模板值 */
+    documentKey: string | TransactionMode;
+    /** 打印方式 */
+    printMode: PrintModeEnums;
+    refModel?: string;
+    /** 模版规则 */
+    documentType: KeyMode;
+    /** 连接规则 */
+    ruleConfig: IObject;
+    /** 打印字段 */
+    printField: string;
+}
+/** 导出按钮属性 */
+export interface ExportProps extends BaseButtonProps {
+    model: string;
+    templateKey: string;
+    timeout: number;
+    /** 关联表格 */
+    refTable?: string;
+}
+/** 按钮容器属性 */
+export interface ButtonContainerProps extends LowCodeWidget.WidgetProps {
+    /** 按钮样式 */
+    buttonStyle: ButtonStyle;
+    /** 对齐方式 */
+    align: AGLINE_ENUMS;
+    /** 间距 */
+    margin: number;
+    /** 尺寸 */
+    size: ButtonSize;
+    /** 所属模型 */
+    model?: string;
+}
+/** 流程按钮容器属性 */
+export interface ButtonProcessContainerProps extends ButtonContainerProps {
+    /** 关联的流程标签 */
+    refForm: string;
+    /** 流程 id */
+    processId: string;
+}