@gct-paas/schema 0.1.4-dev.7

package/es/interface/widget/i-events.d.ts

@@ -0,0 +1,62 @@
+import { EventCategory, INNER_EVENT } from '@gct-paas/core';
+import { IBasicSchema } from './i-schemas';
+import { LowCodeModal } from '../modal';
+/**
+ * 已选中配置的事件 Schema
+ *
+ * @type IBasicEvents
+ */
+export type IBasicEvents = Record<string, IJsEvent | IInnerEvents[] | ILoInterface>;
+/**
+ * JS脚本事件
+ *
+ * @interface IJsEvent
+ */
+export interface IJsEvent {
+    /** 事件类型：脚本逻辑 */
+    type?: EventCategory.JS;
+    /** JS方法名称 */
+    name: string;
+    /** event额外参数 */
+    extraParams: Record<string, any> | string | number | boolean;
+}
+/**
+ * 内部事件
+ *
+ * @interface IInnerEvents
+ */
+export interface IInnerEvents {
+    name: INNER_EVENT;
+    title: string;
+    key: string;
+    refId?: string;
+    scopeId?: string;
+}
+/**
+ * 编排逻辑事件
+ *
+ * @interface ILoInterface
+ */
+export interface ILoInterface {
+    /** 事件类型：编排逻辑 */
+    type: EventCategory.LO;
+    /** JS方法名称 */
+    name: string;
+    /** event额外参数 */
+    extraParams: Record<string, any> | string | number | boolean;
+}
+/**
+ * 组件自身拥有的事件
+ *
+ * @interface IEventsType
+ */
+export interface IEventsType {
+    /** 事件KEY */
+    name: string;
+    /** 事件名 */
+    title: string;
+    /** 事件参数 */
+    params: string[];
+    /** event是否隐藏逻辑 */
+    hidden?: (arg: Partial<IBasicSchema> | Partial<LowCodeModal.Modal>) => boolean;
+}

package/es/interface/widget/i-hooks-and-misc.d.ts

@@ -0,0 +1,58 @@
+import { GLOBAL_VAR_TYPE } from '@gct-paas/core';
+/**
+ * 运行回调
+ *
+ * @type RunCallback
+ */
+export type RunCallback = Function;
+/**
+ * 创建前钩子
+ *
+ * @type beforeCreate
+ */
+export type beforeCreate = Function;
+/**
+ * 新版本拖拽设计钩子，2024年11月4日15:56:37
+ *
+ * @type hooks
+ */
+/**
+ * 循环回调
+ *
+ * @type loopCallback
+ */
+export type loopCallback = (widget: any, Fn: Function) => void;
+/**
+ * 设计页面配置信息
+ *
+ * @interface IDesignerConfig
+ */
+export interface IDesignerConfig {
+    basicProps?: {
+        /** 隐藏key */
+        key_hidden?: boolean;
+        /** 自定义key label */
+        key_label?: string;
+        /** 隐藏别名 */
+        alias_hidden?: boolean;
+        /** 自定义别名label */
+        alias_label?: string;
+    };
+    /** 隐藏遮罩 */
+    hideMask?: boolean;
+}
+/**
+ * 页面变量
+ *
+ * @interface IPageVars
+ */
+export interface IPageVars {
+    id: string;
+    key: string;
+    varInfo: {
+        key: string;
+        type: GLOBAL_VAR_TYPE;
+        defaultValue?: string;
+        description: string;
+    };
+}

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

@@ -0,0 +1,186 @@
+import { FieldMetaDTO } from '@gct-paas/api/apaas';
+import { DisplayType, Dependency_ENUM, ASSIGNMENTSTRATEGY_ENUM, EntityModelCategoryEnum, EntityModelTypeEnum, FIELD_TYPE, UniqueConstraintType } from '@gct-paas/core';
+/**
+ * BasicSchema中的组件prop
+ *
+ * @type ICommonProps
+ */
+export type ICommonProps = Record<string, any>;
+/**
+ * 所有组件的Prop基类
+ *
+ * @type IWidgetProps
+ */
+export type IWidgetProps = IDisplayProps;
+/**
+ * 布局组件Prop Schema
+ *
+ * @type ILayoutProps
+ */
+export type ILayoutProps = IWidgetProps;
+/**
+ * 显隐的Props
+ *
+ * @interface IDisplayProps
+ */
+export interface IDisplayProps {
+    /** 显隐配置-隐藏开关 */
+    hidden: boolean;
+    /** 显隐配置-显隐控制 */
+    displayType?: DisplayType;
+    /** 显隐配置-显隐控制内容 */
+    displayRule?: string;
+    /** 模型信息 */
+    modeldata?: {
+        /** 模型类型 基础/版本/树 等等 */
+        modelType?: EntityModelTypeEnum;
+        /** 模型大类 */
+        modelCategory?: EntityModelCategoryEnum;
+        /** 1表示子表 0表示主表 */
+        subModel?: 0 | 1;
+        /** 1表示流程模型 */
+        supportProcess?: 0 | 1;
+    };
+    /** 组件依赖 */
+    componentDependency: {
+        /** 组件依赖排序 */
+        sortDependency: Dependency_ENUM[];
+        /** 组件依赖配置 */
+        configDependency: IDependency;
+    };
+}
+/**
+ * 组件依赖
+ *
+ * @interface IDependency
+ */
+export interface IDependency {
+    [Dependency_ENUM.HIDDEN]: {
+        expression?: string;
+        value?: boolean;
+    };
+    /** 只读 */
+    [Dependency_ENUM.READONLY]: {
+        expression?: string;
+        value?: boolean;
+        /** 字段组件上的配置信息 */
+        fieldValue?: boolean;
+    };
+    /** 禁用 */
+    [Dependency_ENUM.DISABLED]: {
+        expression?: string;
+        value?: boolean;
+    };
+    /** 必填 */
+    [Dependency_ENUM.REQUIRED]: {
+        expression?: string;
+        value?: boolean;
+        /** 字段组件上的配置信息 */
+        fieldValue?: boolean;
+    };
+    [Dependency_ENUM.ASSIGNMENT]: {
+        expression?: string;
+        strategy?: ASSIGNMENTSTRATEGY_ENUM;
+        value?: boolean;
+    };
+}
+/**
+ * 表单组件Prop Schema
+ *
+ * @interface IFormItemProps
+ * @extends {IWidgetProps}
+ */
+export interface IFormItemProps extends IWidgetProps {
+    /** 字段key */
+    field: string;
+    /** 字段名称 */
+    fieldName?: string;
+    /** 字段id */
+    fieldId: string;
+    /** 字段类型 */
+    fieldType?: FIELD_TYPE;
+    /** 字段链路 */
+    fieldCodeChain?: string;
+    /** 是否是模型关联字段, 模型关联字段的字段key */
+    bindFieldKey?: string;
+    /** 是否是模型关联字段 */
+    isFieldModel?: boolean;
+    /** 自定义名称 */
+    label: string;
+    /** 显示标题 */
+    displayLabelText?: boolean;
+    /** 暗提示 */
+    placeholder?: string;
+    /** 默认值 */
+    defaultValue?: any;
+    /** 必填 */
+    required?: boolean;
+    /** 新建字段那边配置的必填 */
+    fieldRequired?: boolean;
+    /** 只读 */
+    readonly?: boolean;
+    /** 字段只读 */
+    fieldReadonly?: boolean;
+    /** 禁用 */
+    disabled?: boolean;
+    /** 可清空 */
+    clearable?: boolean;
+    /** 获取焦点 */
+    getFocus?: boolean;
+    /** 显示说明开关 */
+    showExplain?: boolean;
+    /** 显示说明文案 */
+    explain?: string;
+    /** 正则校验开关 */
+    regSwitch?: boolean;
+    /** 正则校验提示文案 */
+    regHint?: string;
+    /** 正则校验内容 */
+    reg?: string;
+    /** 显隐配置-隐藏时提交开关 */
+    notSubmitInHide?: boolean;
+    /** 绑定组件样式选择类型 */
+    bindCompStyleType?: string;
+    /** 所属表单的模型key */
+    modelKey: string;
+    /** 关联字段所关联的模型 */
+    bindModelKey?: string;
+    /** 内嵌搜索 */
+    embeddedSearch?: boolean;
+    /** 自定义显示字段 */
+    isCustomField?: boolean;
+    maxlength?: number;
+    minlength?: number;
+    /** 唯一类型 */
+    uniqueConstraintType?: UniqueConstraintType;
+    /** 是否关闭校验 */
+    closeValidator?: boolean;
+    /** 预置字段 不可删除 */
+    _preset?: boolean;
+    /** 关闭自动修复错误数字 */
+    notAutoFix?: boolean;
+    /** 最大值 */
+    maxValue?: any;
+    /** 最小值 */
+    minValue?: any;
+    /** 关联引用下模型的字段的链路 */
+    bindFieldLink?: string[];
+    /** 关联引用下模型依赖的字段 */
+    refOriginField?: string;
+    /** 关联引用下模型依赖的初始字段的模型 */
+    refOriginModelKey?: string;
+    /** 关联引用下模型依赖的初始字段的字段类型 */
+    refOriginFieldType?: FIELD_TYPE;
+}
+/**
+ * 字段到属性映射
+ *
+ * @interface IFieldToProp
+ */
+export interface IFieldToProp {
+    /** 模型建模中字段 */
+    from: keyof FieldMetaDTO;
+    /** 组件PROP中的字段 */
+    to: keyof IFormItemProps | string;
+    transform?: (arg: any) => any;
+}

package/es/interface/widget/i-schemas.d.ts

@@ -0,0 +1,127 @@
+import { CategoryTypeEnum, Platform, FormComponents, DisplayEnums, MaterialEnum, SearchComponents, SEARCH_SEVICE, FIELD_TYPE } from '@gct-paas/core';
+import { IBasicStyle } from './i-styles';
+import { ICommonProps, IWidgetProps, IFormItemProps } from './i-props';
+import { IBasicEvents } from './i-events';
+/**
+ * 单个组件节点描述
+ *
+ * @interface IBasicSchema
+ */
+export interface IBasicSchema {
+    /** 组件唯一标识 */
+    id: string;
+    /** 显示设备 */
+    platform: Platform;
+    /** 组件tag标识 */
+    categoryType?: CategoryTypeEnum;
+    /** 别名 */
+    alias: string;
+    /** 组件名称 */
+    name: string;
+    /** 自定义展示组件的名字 */
+    compName?: string;
+    /** 自定义展示组件key的名字 */
+    compKey?: string;
+    /** 组件类型 需和文件名一致 */
+    type: FormComponents | string;
+    /** icon, 配置组件库使用 */
+    icon: string;
+    /** 子集, 仅布局组件使用 */
+    children?: any[];
+    /** 是否可显示, 配置组件库使用 */
+    internal?: boolean;
+    /** 描述 */
+    description?: string;
+    /** 样式 */
+    style: Partial<IBasicStyle>;
+    /** 组件属性 */
+    props: ICommonProps & IWidgetProps;
+    /** 事件 */
+    events: IBasicEvents;
+    /** 表单组件 */
+    formItem?: boolean;
+    /** 布局 块级 行内 */
+    display?: DisplayEnums;
+    /** 菜单别名 */
+    displayName?: string;
+    /** i18n字段 */
+    i18n?: Record<string, string>;
+    /** 是否是字段类型 */
+    isField?: boolean;
+    /** 字段组件类型使用场景 */
+    materialType?: MaterialEnum;
+    /** 字段所属位置 */
+    preLocation?: string;
+    /** 排除的样式属性 */
+    ignoringStyle?: string[];
+    /** 是否是自读组件,自读则不会有hover和点击选中组件的行为 */
+    isReadonlyWidget?: boolean;
+    /** 部分组件嵌套在某个父组件内部 */
+    parentComponent?: FormComponents;
+    /** 如果是插件，此处是拖入时插件的配置信息 */
+    _plugin?: IObject;
+}
+/**
+ * 字段类型组件
+ *
+ * @interface IFieldSchema
+ * @extends {IBasicSchema}
+ */
+export interface IFieldSchema extends IBasicSchema {
+    props: IFormItemProps & IWidgetProps;
+}
+/**
+ * 包装组件配置参数
+ *
+ * @interface IWrapperCmpConfigParams
+ */
+export interface IWrapperCmpConfigParams {
+    /** 组件基础配置 */
+    data: any;
+    /** 是否是移动端 */
+    isMobile: boolean;
+    /** 平台 */
+    platform: Platform;
+    /** 调用方传入的其他状态 */
+    otherState: Record<string, any>;
+}
+/**
+ * 搜索组件类型
+ *
+ * @interface ISearchSchema
+ */
+export interface ISearchSchema {
+    /** 组件唯一标识 */
+    id: string;
+    /** i18n字段 */
+    i18n: Record<string, string>;
+    /** 组件名称 */
+    name: string;
+    /** 组件类型 需和文件名一致 */
+    type: SearchComponents;
+    alias: string;
+    isSearchField: boolean;
+    materialType: MaterialEnum;
+    props: {
+        /** 字段key */
+        field: string;
+        /** 字段id */
+        fieldId: string;
+        /** 字段类型 */
+        fieldType?: FIELD_TYPE;
+        /** 字段名称 */
+        label: string;
+        defaultValue: any;
+        placeholder: string;
+        ope: SEARCH_SEVICE[];
+        /** 是否区间搜索 */
+        isRang?: boolean;
+        /** 是否启用了其他选项 */
+        useMore?: SEARCH_SEVICE | '';
+        bindModelKey?: string;
+        modelKey?: string;
+        readonly: boolean;
+        diaabled: boolean;
+    };
+    formItem: boolean;
+}

package/es/interface/widget/i-styles.d.ts

@@ -0,0 +1,113 @@
+import { TextDecoration, TagTypeEnum, ProgressTypeEnum, tableColumnWidthEnum, tagEnum } from '@gct-paas/core';
+/**
+ * Font样式
+ *
+ * @interface IFontStyle
+ */
+export interface IFontStyle {
+    fontSize: string;
+    bold: boolean;
+    italic: boolean;
+    textDecoration: TextDecoration;
+    color: string;
+    align: 'left' | 'right';
+}
+/**
+ * 组件只读时开启标签配置的样式
+ *
+ * @interface ITagConfigStyle
+ */
+export interface ITagConfigStyle {
+    color?: string;
+    tagType?: TagTypeEnum;
+}
+/**
+ * 组件只读时开启进度条配置的样式
+ *
+ * @interface IProgressConfigStyle
+ */
+export interface IProgressConfigStyle {
+    color: string;
+    tagType: ProgressTypeEnum;
+}
+/**
+ * 边框样式
+ *
+ * @interface IBorderStyle
+ */
+export interface IBorderStyle {
+    borderWidth: string;
+    borderStyle: string;
+    borderColor: string;
+}
+/**
+ * 表格列字体样式规则
+ *
+ * @interface IColumnFontStyleByRule
+ */
+export interface IColumnFontStyleByRule {
+    displayRule: string;
+    contentFont: IFontStyle;
+    tagStyle: ITagConfigStyle;
+    progressStyle: IProgressConfigStyle;
+    tagType: tagEnum;
+    tagStyleOpen: boolean;
+}
+/**
+ * 表格列背景规则
+ *
+ * @interface IColumnBackgroundByRule
+ */
+export interface IColumnBackgroundByRule {
+    displayRule: string;
+    backgroundColor?: string;
+}
+/**
+ * 样式Schema
+ *
+ * @interface IBasicStyle
+ */
+export interface IBasicStyle {
+    position?: string;
+    top?: string;
+    left?: string;
+    right?: string;
+    bottom?: string;
+    width?: string;
+    height?: string;
+    maxHeight?: string;
+    backgroundColor?: string;
+    marginAll?: string;
+    marginTop?: string;
+    marginRight?: string;
+    marginBottom?: string;
+    marginLeft?: string;
+    paddingAll?: string;
+    paddingTop?: string;
+    paddingRight?: string;
+    paddingBottom?: string;
+    paddingLeft?: string;
+    labelFont: IFontStyle;
+    contentFont: IFontStyle;
+    tagStyle: ITagConfigStyle;
+    tagStyleOpen: boolean;
+    borderAll: Partial<IBorderStyle>;
+    borderLeft: Partial<IBorderStyle>;
+    borderRight: Partial<IBorderStyle>;
+    borderBottom: Partial<IBorderStyle>;
+    borderTop: Partial<IBorderStyle>;
+    borderTopRightRadius?: string;
+    borderTopLeftRadius?: string;
+    borderBottomRightRadius?: string;
+    borderBottomLeftRadius?: string;
+    borderAllRadius?: string;
+    /** 表格列宽样式 */
+    columnwidthConfigure?: tableColumnWidthEnum;
+    /** 表格列宽 */
+    columnwidth?: number;
+    columnFontStyleByRule?: IColumnFontStyleByRule[];
+    columnBackgroundByRule?: IColumnBackgroundByRule[];
+    tableheight?: number;
+    /** 表格高度样式 */
+    tableheightConfigure?: tableColumnWidthEnum;
+}

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

@@ -0,0 +1,46 @@
+import { IBasicSchema, IFieldSchema, ISearchSchema, IWrapperCmpConfigParams as IWrapperCmpConfigParamsSelf } from './i-schemas';
+import { ICommonProps, IWidgetProps, IDisplayProps, IFormItemProps, ILayoutProps, IDependency, IFieldToProp } from './i-props';
+import { IBasicStyle, IFontStyle, IBorderStyle, ITagConfigStyle, IProgressConfigStyle, IColumnFontStyleByRule, IColumnBackgroundByRule } from './i-styles';
+import { IBasicEvents, IJsEvent, IInnerEvents, ILoInterface, IEventsType } from './i-events';
+import { IStyleEditor, IStyleEditorConfig, IPropEditor, IPropEditorConfig } from './i-editors';
+import { IDesignerConfig, IPageVars, RunCallback as RunCallbackSelf, beforeCreate as beforeCreateSelf, loopCallback as loopCallbackSelf } from './i-hooks-and-misc';
+export type * from './i-common';
+/**
+ * 低代码组件命名空间
+ *
+ * 包含所有低代码组件相关的类型定义
+ */
+export declare namespace LowCodeWidget {
+    type BasicSchema = IBasicSchema;
+    type FieldSchema = IFieldSchema;
+    type SearchSchema = ISearchSchema;
+    type IWrapperCmpConfigParams = IWrapperCmpConfigParamsSelf;
+    type CommonProps = ICommonProps;
+    type WidgetProps = IWidgetProps;
+    type DisplayProps = IDisplayProps;
+    type FormItemProps = IFormItemProps;
+    type LayoutProps = ILayoutProps;
+    type Dependency = IDependency;
+    type FieldToProp = IFieldToProp;
+    type BasicStyle = IBasicStyle;
+    type FontStyle = IFontStyle;
+    type BorderStyle = IBorderStyle;
+    type TagConfigStyle = ITagConfigStyle;
+    type ProgressConfigStyle = IProgressConfigStyle;
+    type columnFontStyleByRule = IColumnFontStyleByRule;
+    type columnBackgroundByRule = IColumnBackgroundByRule;
+    type BasicEvents = IBasicEvents;
+    type JsEvent = IJsEvent;
+    type InnerEvents = IInnerEvents;
+    type LoInterface = ILoInterface;
+    type EventsType = IEventsType;
+    type StyleEditor = IStyleEditor;
+    type StyleEditorConfig = IStyleEditorConfig;
+    type PropEditor = IPropEditor;
+    type PropEditorConfig = IPropEditorConfig;
+    type RunCallback = RunCallbackSelf;
+    type beforeCreate = beforeCreateSelf;
+    type loopCallback = loopCallbackSelf;
+    type DesignerConfig = IDesignerConfig;
+    type PageVars = IPageVars;
+}

package/es/schema/common-config/common-style.d.ts

@@ -0,0 +1,3 @@
+import { LowCodeWidget } from '../../interface';
+export declare const commonStyle: LowCodeWidget.BasicStyle;
+export declare const notNeedPxStyle: string[];

package/es/schema/common-config/common-style.mjs

@@ -0,0 +1,85 @@
+import { BorderStyle, TagTypeEnum, TextDecoration } from '@gct-paas/core';
+
+const commonStyle = {
+  position: "",
+  top: "",
+  left: "",
+  right: "",
+  bottom: "",
+  width: "",
+  height: "",
+  backgroundColor: "",
+  marginAll: "",
+  marginTop: "",
+  marginRight: "",
+  marginBottom: "",
+  marginLeft: "",
+  paddingAll: "",
+  paddingTop: "",
+  paddingRight: "",
+  paddingBottom: "",
+  paddingLeft: "",
+  labelFont: {
+    align: "left",
+    fontSize: "",
+    bold: false,
+    italic: false,
+    textDecoration: TextDecoration.NONE,
+    color: ""
+  },
+  contentFont: {
+    align: "left",
+    fontSize: "",
+    bold: false,
+    italic: false,
+    textDecoration: TextDecoration.NONE,
+    color: ""
+  },
+  tagStyle: {
+    color: "",
+    tagType: TagTypeEnum.RADIUS
+  },
+  tagStyleOpen: false,
+  borderAll: {
+    borderStyle: BorderStyle.NONE,
+    borderColor: "#F0F0F0",
+    borderWidth: "1"
+  },
+  borderLeft: {
+    borderStyle: BorderStyle.NONE,
+    borderColor: "#F0F0F0",
+    borderWidth: "1"
+  },
+  borderRight: {
+    borderStyle: BorderStyle.NONE,
+    borderColor: "#F0F0F0",
+    borderWidth: "1"
+  },
+  borderBottom: {
+    borderStyle: BorderStyle.NONE,
+    borderColor: "#F0F0F0",
+    borderWidth: "1"
+  },
+  borderTop: {
+    borderStyle: BorderStyle.NONE,
+    borderColor: "#F0F0F0",
+    borderWidth: "1"
+  },
+  borderTopRightRadius: "0",
+  borderTopLeftRadius: "0",
+  borderBottomRightRadius: "0",
+  borderBottomLeftRadius: "0",
+  borderAllRadius: "0"
+};
+const notNeedPxStyle = [
+  "position",
+  "backgroundColor",
+  "bold",
+  "italic",
+  "textDecoration",
+  "color",
+  "borderStyle",
+  "borderColor"
+];
+
+export { commonStyle, notNeedPxStyle };

package/es/schema/index.d.ts

@@ -0,0 +1 @@
+export { commonStyle, notNeedPxStyle } from './common-config/common-style';

package/es/types/index.d.ts

@@ -0,0 +1 @@
+import '@gct-paas/core/types';

package/es/utils/index.d.ts

@@ -0,0 +1 @@
+export { getCompPos } from './schema';

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

@@ -0,0 +1,11 @@
+import { LowCodeWidget } from '../../interface';
+/**
+ * 获取组件所属位置
+ *
+ * @export
+ * @param {LowCodeWidget.BasicSchema} widget
+ * @param {string} fieldType
+ * @param {string} componentType
+ * @return {*}
+ */
+export declare function getCompPos(widget: LowCodeWidget.BasicSchema, fieldType: string, componentType: string): boolean;