@gct-paas/design 0.1.4-dev.1 → 0.1.4-dev.11

package/es/interface/controller/i-design-view.controller.d.ts

@@ -1,35 +1,74 @@
-import { IDesignerProvider, LowCodeWidget } from '@gct-paas/core';
+import { Store } from 'pinia';
 import { IDesignViewState } from '../state/i-design-view.state';
+import { IDesignViewActions } from '../actions/i-design-view.actions';
+import { DesignViewHooks } from '../../hooks/designer.hooks';
+import { IDesignNode } from '../design';
 /**
  * 设计界面控制器
  *
+ * @author zhanghanrui
+ * @date 2024-07-05 14:07:01
  * @export
  * @interface IDesignViewController
  */
 export interface IDesignViewController {
     /**
-     * 设计界面状态
+     * 界面状态
      *
-     * @type {IDesignViewState}
+     * @author zhanghanrui
+     * @date 2024-07-05 14:07:20
+     * @type {Store<string, IDesignViewState, {}, IDesignViewActions>}
      */
-    readonly state: IDesignViewState;
+    readonly store: Store<string, IDesignViewState, object, IDesignViewActions>;
     /**
-     * 设计界面所有适配器
+     * 设计界面钩子
      *
-     * @type {IDesignerProvider[]}
+     * @type {DesignViewHooks}
      */
-    readonly providers: IDesignerProvider[];
+    readonly hooks: DesignViewHooks;
     /**
-     * 获取指定插件适配器
+     * 效验设计界面数据
      *
-     * @param {string} tag
-     * @returns {*}  {(IDesignerProvider | undefined)}
+     * @author zhanghanrui
+     * @date 2024-08-04 15:08:24
+     * @return {*}  {Promise<boolean>}
      */
-    getProvider(tag: string): IDesignerProvider | undefined;
+    validate(): Promise<boolean>;
     /**
-     * 激活选中组件
+     * 界面挂载时调用
      *
-     * @param {LowCodeWidget.BasicSchema} widget
+     * @author zhanghanrui
+     * @date 2024-07-05 14:07:24
      */
-    setSelect(widget: LowCodeWidget.BasicSchema): void;
+    mounted(): void;
+    /**
+     * 界面销毁调用
+     *
+     * @author zhanghanrui
+     * @date 2024-07-05 14:07:53
+     */
+    unmounted(): void;
+    /**
+     * 设置容器展开节点
+     *
+     * @param {string[]} ids
+     */
+    setExpansion(ids: string[]): void;
+    /**
+     * 取消容器展开节点
+     *
+     */
+    cancelExpansion(): void;
+    /**
+     * 获取当前节点所有子节点类型
+     *
+     * @param {IDesignNode} node
+     * @returns {*}  {string[]}
+     */
+    types(node: IDesignNode): string[];
+    /**
+     * 结束放置
+     *
+     */
+    dropEnd(): void;
 }

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

@@ -0,0 +1,13 @@
+import { IDesignNode } from './i-design-node';
+import { IDesignNodeData } from './i-design-node-data';
+/**
+ * 容器节点
+ *
+ * @author zhanghanrui
+ * @date 2024-07-12 17:07:56
+ * @export
+ * @interface IDesignContainerNode
+ * @extends {IDesignNode<T>}
+ * @template T
+ */
+export type IDesignContainerNode<T extends IDesignNodeData = IDesignNodeData> = IDesignNode<T>;

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

@@ -0,0 +1,44 @@
+import { IDesignNode } from './i-design-node';
+import { IDesignTreeItem } from './i-design-tree-item';
+/**
+ * 设计 json
+ *
+ * @author zhanghanrui
+ * @date 2024-07-11 17:07:54
+ * @export
+ * @interface IDesignData
+ */
+export interface IDesignData {
+    /**
+     * 设计界面类型
+     *
+     * @author zhanghanrui
+     * @date 2024-10-12 09:10:39
+     * @type {string}
+     */
+    type: string;
+    /**
+     * 页面节点
+     *
+     * @author zhanghanrui
+     * @date 2024-07-24 10:07:39
+     * @type {IDesignNode | null}
+     */
+    pageNode: IDesignNode | null;
+    /**
+     * 设计元素节点
+     *
+     * @author zhanghanrui
+     * @date 2024-07-11 17:07:01
+     * @type {IDesignNode[]}
+     */
+    nodes: IDesignNode[];
+    /**
+     * 层级树
+     *
+     * @author zhanghanrui
+     * @date 2024-08-20 10:08:11
+     * @type {IDesignTreeItem[]}
+     */
+    tree: IDesignTreeItem[];
+}

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

@@ -0,0 +1,20 @@
+import { IDesignNodeData } from './i-design-node-data';
+/**
+ * 设计编辑器数据接口
+ *
+ * @author chitanda
+ * @date 2025-07-07 15:07:57
+ * @export
+ * @interface IDesignEditorData
+ * @extends {IDesignNodeData}
+ */
+export interface IDesignEditorData extends IDesignNodeData {
+    /**
+     * 属性配置
+     *
+     * @author chitanda
+     * @date 2025-07-07 15:07:03
+     * @type {IObject}
+     */
+    field: IObject;
+}

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

@@ -0,0 +1,15 @@
+import { IDesignEditorData } from './i-design-editor-data';
+import { IDesignNode } from './i-design-node';
+/**
+ * 设计编辑器节点接口
+ *
+ * @author chitanda
+ * @date 2025-07-07 15:07:25
+ * @export
+ * @interface IDesignEditorNode
+ * @extends {IDesignNode<T>}
+ * @template T
+ */
+export interface IDesignEditorNode<T extends IDesignEditorData = IDesignEditorData> extends IDesignNode<T> {
+    [key: string]: any;
+}

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-model-field-node-data/i-model-field-node-data.d.ts

@@ -0,0 +1,158 @@
+import { IDesignNodeData } from '../i-design-node-data';
+import { IFieldCodeChain, IFont, TagTypeEnum } from '@gct-paas/core';
+/**
+ * 卡片字段设计节点数据接口
+ *
+ * @author chitanda
+ * @date 2025-06-18 17:06:52
+ * @export
+ * @interface IModelFieldNodeData
+ * @extends {IDesignNodeData}
+ */
+export interface IModelFieldNodeData extends IDesignNodeData {
+    /**
+     * 模型标识
+     *
+     * @author chitanda
+     * @date 2025-07-02 09:07:02
+     * @type {string}
+     */
+    modelKey: string;
+    /**
+     * 模型分类
+     *
+     * @author chitanda
+     * @date 2025-07-02 09:07:07
+     * @type {string}
+     */
+    modelCategory: string;
+    /**
+     * 字段标识
+     *
+     * @author chitanda
+     * @date 2025-06-18 19:06:47
+     * @type {string}
+     */
+    key: string;
+    /**
+     * 字段类型
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:03
+     * @type {string}
+     */
+    type: string;
+    /**
+     * 字段映射类型
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:33
+     * @type {string}
+     */
+    mapping_type?: string;
+    /**
+     * 字段代码链，表示字段的完整路径。根据字段的层级关系进行拼接
+     *
+     * @author chitanda
+     * @date 2025-06-22 14:06:03
+     * @type {IFieldCodeChain}
+     */
+    fieldCodeChain?: IFieldCodeChain;
+    /**
+     * 用户自定义的显示名称，未定义则使用字段的名称
+     *
+     * @author chitanda
+     * @date 2025-06-19 10:06:23
+     * @type {string}
+     */
+    label?: string;
+    /**
+     * 字段名称
+     *
+     * @author chitanda
+     * @date 2025-06-30 11:06:27
+     * @type {string}
+     */
+    name: string;
+    /**
+     * 是否显示标签
+     *
+     * @default true
+     * @author chitanda
+     * @date 2025-06-22 11:06:43
+     * @type {boolean}
+     */
+    show_label?: boolean;
+    /**
+     * 编辑器类型
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:37
+     * @type {string}
+     */
+    editor_type?: string;
+    /**
+     * 币种：根据编辑器类型显示
+     *
+     * @author chitanda
+     * @date 2025-06-24 14:06:00
+     * @type {string}
+     */
+    currency?: string;
+    /**
+     * 时间类型：根据编辑器类型显示
+     *
+     * @author chitanda
+     * @date 2025-06-24 14:06:58
+     * @type {string}
+     */
+    time_type?: string;
+    /**
+     * 格式化分割符存储的配置项
+     *
+     * @author chitanda
+     * @date 2025-06-23 19:06:21
+     * @type {string}
+     */
+    separator?: string;
+    /**
+     * 字段格式化方式
+     *
+     * @author chitanda
+     * @date 2025-06-22 11:06:55
+     * @type {string}
+     */
+    format?: string;
+    /**
+     * 标签字体样式配置
+     *
+     * @author chitanda
+     * @date 2025-06-24 19:06:36
+     * @type {IFont}
+     */
+    label_font?: IFont;
+    /**
+     * 内容字体样式配置
+     *
+     * @author chitanda
+     * @date 2025-06-24 19:06:38
+     * @type {IFont}
+     */
+    content_font?: IFont;
+    /**
+     * 标签样式配置
+     *
+     * @author chitanda
+     * @date 2025-06-24 19:06:01
+     * @type {{
+     *     check: boolean;
+     *     color: string;
+     *     mode: TagTypeEnum;
+     *   }}
+     */
+    tag_style?: {
+        check: boolean;
+        color: string;
+        mode: TagTypeEnum;
+    };
+}

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

@@ -0,0 +1,9 @@
+export type { IModelFieldNodeData } from './i-model-field-node-data/i-model-field-node-data';
+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';

package/es/interface/designer/i-designer-hooks.d.ts

@@ -0,0 +1,26 @@
+import { SyncSeriesHook } from 'qx-util';
+import { LowCodeWidget } from '@gct-paas/schema';
+/**
+ * 设计界面钩子接口
+ *
+ * @export
+ * @interface IDesignerHooks
+ */
+export interface IDesignerHooks {
+    /**
+     * 触发执行设计容器扩容展示
+     */
+    expansion: SyncSeriesHook<[], LowCodeWidget.BasicSchema[]>;
+    /**
+     * 触发选中项重选
+     */
+    selectHighlightChange: SyncSeriesHook<[]>;
+    /**
+     * 触发悬浮项重选
+     */
+    hoverHighlightChange: SyncSeriesHook<[]>;
+    /**
+     * 设置选中项
+     */
+    setSelect: SyncSeriesHook<[key: string]>;
+}

package/es/interface/designer/i-designer-provider.d.ts

@@ -0,0 +1,20 @@
+import { Component } from 'vue';
+import { IWidgetInfoItem } from '@gct-paas/schema';
+/**
+ * 设计界面项
+ *
+ * @author zhanghanrui
+ * @date 2024-05-24 13:05:47
+ * @export
+ * @interface IDesignerProvider
+ */
+export interface IDesignerProvider extends IWidgetInfoItem {
+    /**
+     * render 绘制组件，目前只支持异步组件
+     *
+     * @author zhanghanrui
+     * @date 2024-05-24 17:05:17
+     * @type {Component}
+     */
+    component: Component;
+}

package/es/interface/designer/i-designer-state.d.ts

@@ -0,0 +1,41 @@
+import { LowCodeWidget } from '@gct-paas/schema';
+/**
+ * 设计器状态接口
+ *
+ * @author zhanghanrui
+ * @date 2024-05-09 14:05:44
+ * @export
+ * @interface IDesignerState
+ */
+export interface IDesignerState {
+    /**
+     * 设计页面是否正在拖拽中
+     */
+    isDragging: boolean;
+    /**
+     * 当前正在拖拽中的数据(旧拖拽)
+     *
+     * @deprecated
+     * @type {IData | null}
+     */
+    draggingData: IData | null;
+    /**
+     * 当前鼠标容器悬浮元素(旧拖拽)
+     *
+     * @deprecated
+     * @type {(HTMLDivElement | null)}
+     */
+    hoverEL: HTMLDivElement | null;
+    /**
+     * 拖拽放置目标容器
+     */
+    dropContainer: LowCodeWidget.BasicSchema | null;
+    /**
+     * 需要扩张的容器列表
+     */
+    expansionContainerList: LowCodeWidget.BasicSchema[];
+    /**
+     * 数据变更次数，主要用于复杂结构下，数据变更后的设计界面重绘
+     */
+    count: number;
+}

package/es/interface/designer/i-designer.controller.d.ts

@@ -0,0 +1,116 @@
+import { LowCodeWidget } from '@gct-paas/schema';
+import { IDesignerHooks } from './i-designer-hooks';
+import { IDesignerState } from './i-designer-state';
+/**
+ * 设计界面控制器接口
+ *
+ * @author zhanghanrui
+ * @date 2024-05-09 14:05:12
+ * @export
+ * @interface IDesignerController
+ */
+export interface IDesignerController {
+    /**
+     * 设计界面状态
+     *
+     * @author zhanghanrui
+     * @date 2024-05-09 14:05:19
+     */
+    readonly state: IDesignerState;
+    /**
+     * 设计界面钩子
+     *
+     * @type {IDesignerHooks}
+     */
+    readonly hooks: IDesignerHooks;
+    /**
+     * 鼠标悬浮元素清单
+     *
+     * @author zhanghanrui
+     * @date 2024-05-10 10:05:47
+     * @type {HTMLDivElement[]}
+     */
+    readonly hoverStack: HTMLDivElement[];
+    /**
+     * 拖拽设计区容器
+     *
+     * @author zhanghanrui
+     * @date 2024-05-10 13:05:46
+     * @type {HTMLDivElement}
+     */
+    stageContainer: HTMLDivElement;
+    /**
+     * 拖拽展开定时器
+     *
+     * @type {(number | null)}
+     */
+    expansionTimer: number | null;
+    /**
+     * 设置拖拽数据
+     *
+     * @author zhanghanrui
+     * @date 2024-05-09 14:05:31
+     * @param {(IData | null)} data
+     */
+    setDragData(data: IData | null): void;
+    /**
+     * 获取当前拖拽数据
+     *
+     * @author zhanghanrui
+     * @date 2024-05-09 14:05:49
+     * @return {*}  {(IData | null)}
+     */
+    getDragData(): IData | null;
+    /**
+     * 新增鼠标悬浮堆栈
+     *
+     * @author zhanghanrui
+     * @date 2024-05-10 10:05:02
+     * @param {HTMLDivElement} el
+     */
+    pushStack(el: HTMLDivElement): void;
+    /**
+     * 删除鼠标悬浮堆栈
+     *
+     * @author zhanghanrui
+     * @date 2024-05-08 11:05:53
+     * @param {HTMLDivElement} el
+     */
+    popStack(el: HTMLDivElement): void;
+    /**
+     * 重置悬浮缓存
+     *
+     * @author zhanghanrui
+     * @date 2024-05-15 11:05:51
+     */
+    resetStack(): void;
+    /**
+     * 添加展开容器
+     *
+     * @param {LowCodeWidget.BasicSchema[]} widgets
+     * @returns {*}  {void}
+     */
+    setExpansion(widgets: LowCodeWidget.BasicSchema[]): void;
+    /**
+     * 取消展开容器
+     */
+    cancelExpansion(): void;
+    /**
+     * 强制设计界面重绘
+     */
+    force(): void;
+    /**
+     * 重新计算选中高亮
+     */
+    changeSelectHighlight(): void;
+    /**
+     * 重新计算悬浮高亮
+     */
+    changeHoverHighlight(): void;
+    /**
+     * 设置选中
+     *
+     * @param {string} key
+     */
+    setSelect(key: string): void;
+}