ehr-form-engine 1.0.0-beta.4 → 1.0.0-beta.41

package/dist/src/types/config.d.ts

@@ -0,0 +1,190 @@
+import { InjectionKey } from 'vue';
+import { ConfigProviderProps as AntConfigProviderProps } from 'ant-design-vue/es/config-provider';
+
+/**
+ * 主题配置类型（继承自 Ant Design Vue ConfigProvider）
+ */
+export type ThemeConfig = AntConfigProviderProps['theme'];
+/**
+ * 上传文件数据类型
+ * 【关键】uid 字段用于唯一标识文件，业务端必须提供
+ */
+export interface UploadFileData {
+    /**
+     * 文件 URL
+     */
+    url: string;
+    /**
+     * 文件名
+     */
+    name: string;
+    /**
+     * 文件大小（字节）
+     */
+    size?: number;
+    /**
+     * 文件类型（MIME）
+     */
+    type?: string;
+    /**
+     * 状态
+     */
+    status?: 'done' | 'uploading' | 'error';
+    /**
+     * 【关键】文件唯一标识
+     * 规则：
+     * - 后端返回的文件：使用后端提供的 ID 或 url
+     * - 新上传的文件：使用生成的唯一标识（如：Date.now() + Math.random()）
+     * - 用途：业务端通过 uid 区分新增/删除/保留的文件
+     * @example 'file_1691234567890_abc123'
+     */
+    uid: string;
+}
+/**
+ * 上传处理函数类型
+ * 由业务应用注入，组件库只负责调用
+ */
+export type UploadHandler = (files: File[], options: {
+    /** 上传字段类型 */
+    fieldType: string;
+    /** 进度回调 */
+    onProgress: (percent: number) => void;
+}) => Promise<UploadFileData[]>;
+/**
+ * 上传组件全局配置
+ */
+export interface UploadGlobalConfig {
+    /**
+     * 【推荐】自定义上传处理函数
+     * 优先级高于 defaultUploadApiUrl
+     * 如果提供，组件库将使用此函数代替默认 xhr 上传
+     */
+    uploadHandler?: UploadHandler;
+    /**
+     * 【兼容保留】默认上传 API 地址
+     * 当 uploadHandler 未提供时，使用内置 xhr 上传
+     * @deprecated 建议使用 uploadHandler
+     */
+    defaultUploadApiUrl?: string;
+    /**
+     * 上传类型对应的宽度映射
+     * 可被组件 schema.pixel.width 覆盖
+     */
+    typeWidthMap?: Record<string, number>;
+    /**
+     * 上传类型对应的高度映射
+     * 可被组件 schema.pixel.height 覆盖
+     */
+    typeHeightMap?: Record<string, number>;
+    /**
+     * 默认单图上传接口路径后缀
+     * @default 'single'
+     */
+    singleUploadPath?: string;
+    /**
+     * 默认多图上传接口路径后缀
+     * @default 'multiple'
+     */
+    multipleUploadPath?: string;
+}
+/**
+ * 表格组件全局配置
+ */
+export interface TableGlobalConfig {
+    /**
+     * 表格滚动加载的防抖延迟（毫秒）
+     * @default 800
+     */
+    scrollDebounceMs?: number;
+    /**
+     * 默认分页大小选项
+     * @default [10, 20, 50, 100]
+     */
+    pageSizeOptions?: number[];
+    /**
+     * 默认每页条数
+     * @default 20
+     */
+    defaultPageSize?: number;
+}
+/**
+ * 设计器全局配置
+ */
+export interface DesignerGlobalConfig {
+    /**
+     * 是否启用组件拖拽动画
+     * @default true
+     */
+    enableDragAnimation?: boolean;
+    /**
+     * 拖拽动画持续时间（毫秒）
+     * @default 300
+     */
+    dragAnimationDurationMs?: number;
+    /**
+     * 属性面板宽度
+     * @default 300
+     */
+    propertyPanelWidth?: number;
+}
+/**
+ * 校验规则全局配置
+ */
+export interface ValidationGlobalConfig {
+    /**
+     * 必填项错误消息模板
+     * @default '{field} 为必填项'
+     */
+    requiredMessageTemplate?: string;
+    /**
+     * 最小上传数量错误消息模板
+     * @default '{field} 至少需要上传 {min} 个附件'
+     */
+    minUploadCountMessageTemplate?: string;
+    /**
+     * 自定义校验规则扩展
+     */
+    customRules?: Record<string, {
+        pattern: RegExp;
+        message: string;
+    }>;
+}
+/**
+ * 组件库全局配置对象
+ */
+export interface HrFormEngineConfig {
+    /**
+     * 上传组件配置
+     */
+    upload?: UploadGlobalConfig;
+    /**
+     * 表格组件配置
+     */
+    table?: TableGlobalConfig;
+    /**
+     * 设计器配置
+     */
+    designer?: DesignerGlobalConfig;
+    /**
+     * 校验规则配置
+     */
+    validation?: ValidationGlobalConfig;
+    /**
+     * 主题配置（透传给 Ant Design Vue ConfigProvider）
+     * 支持配置 algorithm: theme.darkAlgorithm 开启暗黑模式
+     */
+    theme?: ThemeConfig;
+    /**
+     * 是否开启调试模式
+     * @default false
+     */
+    debug?: boolean;
+}
+/**
+ * 配置注入 key
+ */
+export declare const HR_FORM_ENGINE_CONFIG_KEY: InjectionKey<HrFormEngineConfig>;
+/**
+ * 默认配置
+ */
+export declare const DEFAULT_CONFIG: HrFormEngineConfig;

package/dist/src/types/designer.types.d.ts

@@ -0,0 +1,51 @@
+import { JsonSchemaType } from './schema.types';
+
+/**
+ * Schema 节点索引项
+ * 用于 O(1) 时间复杂度的节点查找
+ */
+export interface SchemaNodeIndex {
+    /** 节点本身 */
+    node: JsonSchemaType;
+    /** 父节点 ID（根节点为 null） */
+    parentId: null | string;
+    /** 节点在父容器中的索引路径 */
+    path: number[];
+    /** 节点深度（层级） */
+    depth: number;
+    /** 是否为叶子节点 */
+    isLeaf: boolean;
+}
+/**
+ * Schema 索引 Map
+ * key: 节点 ID
+ * value: 节点索引信息
+ */
+export type SchemaIndexMap = Map<string, SchemaNodeIndex>;
+/**
+ * 索引构建选项
+ */
+export interface BuildIndexOptions {
+    /** 是否包含根节点 */
+    includeRoot?: boolean;
+    /** 最大深度（防止循环引用） */
+    maxDepth?: number;
+}
+/**
+ * 索引更新操作类型
+ */
+export type IndexUpdateType = {
+    newIndex: number;
+    newParentId: string;
+    nodeId: string;
+    type: 'move';
+} | {
+    node: JsonSchemaType;
+    parentId: string;
+    type: 'add';
+} | {
+    nodeId: string;
+    type: 'remove';
+} | {
+    type: 'rebuild';
+};

package/dist/src/types/index.d.ts

@@ -1,2 +1,18 @@
+export type { BindingConfig, ColumnDataType, DatePickerFormatType, DatePickerType, DependencyCondition, DependencyRuleType, DependencyRulesType, DragGroupType, FieldId, FieldValue, FormData, InputModeType, ItemTypeTag, LogicalOperator, PanelListType, PatternRule, RequiredRule, RuleItem, RulesType, SelectModeType, SelectPlacementType, SlotComponentConfig, SlotItem, SlotsType, TableActions, TableFieldType, TimerPickerFormatType, TriggerType, UploadListType, ValidatorType, } from './base.types';
+export type { ColumnComponentProps, ComponentProps } from './component.types';
+export type { BuildIndexOptions, IndexUpdateType, SchemaIndexMap, SchemaNodeIndex, } from './designer.types';
+export { isColumnSchema, isColumnSchemaType, isContainerSchema, isContainerSchemaType, isFieldSchema, isFieldSchemaType, isTableSchema, isTableSchemaType, isUploadSchema, isUploadSchemaType, } from './schema.guards';
+export type { BaseSchema, CascaderFieldSchema, CheckboxGroupFieldSchema, DatePickerFieldSchema, FieldSchema, InputFieldSchema, InputNumberFieldSchema, InputPasswordFieldSchema, RadioGroupFieldSchema, RangePickerFieldSchema, RateFieldSchema, SelectFieldSchema, SliderFieldSchema, SwitchFieldSchema, TextareaFieldSchema, TimePickerFieldSchema, TimeRangePickerFieldSchema, UploadFieldSchema, FieldSchemaType, CascaderColumnSchema, ColumnSchema, DatePickerColumnSchema, InputColumnSchema, InputNumberColumnSchema, SelectColumnSchema, TextareaColumnSchema, TimePickerColumnSchema, ColumnSchemaType, ContainerSchema, TableSchema, UploadSchema, UploadSetting, DraggableItemType, JsonSchemaType, DynamicRowVO, DynamicGridEditRender, DynamicGridProps, DynamicFormEditRender, DynamicFormProps, } from './schema.types';
+export type { ColProp, LabelProp, Option, StrictProps, StrictRootType } from './utility.types';
 export * from './emits';
-export * from './types';
+export * from './config';
+/** @deprecated 使用 TableSchema 替代 */
+export type TableSchemaType = import('./schema.types').TableSchema;
+/** @deprecated 使用 UploadSchema 替代 */
+export type UploadSchemaType = import('./schema.types').UploadSchema;
+/** @deprecated 使用 ContainerSchema 替代 */
+export type ContainerSchemaType = import('./schema.types').ContainerSchema;
+/** @deprecated 使用 FieldSchema 替代 */
+export type FieldSchemaTypeAlias = import('./schema.types').FieldSchema;
+/** @deprecated 使用 ColumnSchema 替代 */
+export type ColumnSchemaTypeAlias = import('./schema.types').ColumnSchema;

package/dist/src/types/schema.guards.d.ts

@@ -0,0 +1,63 @@
+import { ValidComponentName, ValidColumnComponentName, JsonSchemaType, TableSchema, UploadSchema, ContainerSchema, FieldSchema, ColumnSchema } from './schema.types';
+import { ItemTypeTag } from './base.types';
+
+/**
+ * 检查值是否为有效的组件名称
+ */
+export declare function isValidComponentName(value: unknown): value is ValidComponentName;
+/**
+ * 检查值是否为有效的列组件名称
+ */
+export declare function isValidColumnComponentName(value: unknown): value is ValidColumnComponentName;
+/**
+ * 检查值是否为有效的拖拽项类型标签
+ */
+export declare function isItemTypeTag(value: unknown): value is ItemTypeTag;
+/**
+ * 检查值是否为 JsonSchemaType 的基础结构
+ * 注意：这只是基础检查，具体类型需要进一步判断
+ */
+export declare function isJsonSchemaType(value: unknown): value is JsonSchemaType;
+/**
+ * 检查值是否为 ColumnSchema
+ * 使用类型断言避免 TypeScript 过度收窄类型
+ */
+export declare function isColumnSchema(value: unknown): value is ColumnSchema;
+/** @deprecated 使用 isColumnSchema 替代 */
+export declare const isColumnSchemaType: typeof isColumnSchema;
+/**
+ * 检查值是否为 FieldSchema
+ * 使用类型断言避免 TypeScript 过度收窄类型
+ */
+export declare function isFieldSchema(value: unknown): value is FieldSchema;
+/** @deprecated 使用 isFieldSchema 替代 */
+export declare const isFieldSchemaType: typeof isFieldSchema;
+/**
+ * 检查值是否为 TableSchema
+ * 使用类型断言避免 TypeScript 过度收窄类型
+ */
+export declare function isTableSchema(value: unknown): value is TableSchema;
+/** @deprecated 使用 isTableSchema 替代 */
+export declare const isTableSchemaType: typeof isTableSchema;
+/**
+ * 检查值是否为 UploadSchema
+ * 使用类型断言避免 TypeScript 过度收窄类型
+ */
+export declare function isUploadSchema(value: unknown): value is UploadSchema;
+/** @deprecated 使用 isUploadSchema 替代 */
+export declare const isUploadSchemaType: typeof isUploadSchema;
+/**
+ * 检查值是否为 ContainerSchema
+ * 使用类型断言避免 TypeScript 过度收窄类型
+ */
+export declare function isContainerSchema(value: unknown): value is ContainerSchema;
+/** @deprecated 使用 isContainerSchema 替代 */
+export declare const isContainerSchemaType: typeof isContainerSchema;
+/**
+ * 检查组件是否需要选项数据
+ */
+export declare function componentNeedsOptions(componentName: ValidComponentName): boolean;
+/**
+ * 检查组件是否支持表格列
+ */
+export declare function isValidColumnComponent(componentName: string): boolean;