ht-emr 0.6.2 → 0.6.3

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

@@ -1,6 +1,6 @@
 import './assets/css/index.css';
 import { IEditorData, IEditorOption, IEditorResult, IFormModeTraceOption } from './interface/Editor';
-import { IElement, IMacroConfig, IMacroElement, IGetMacroValueOption, IMacroValueResult, ISetMacroValueOption, IUpdateMacroPropertiesOption, ISubTemplateElement } from './interface/Element';
+import { IElement, IMacroConfig, IMacroElement, ILogicTemplateDisplayRule, ILogicTemplateElement, IGetMacroValueOption, IMacroValueResult, ISetMacroValueOption, IUpdateMacroPropertiesOption, ISubTemplateElement } from './interface/Element';
 import { Command } from './core/command/Command';
 import { Listener } from './core/listener/Listener';
 import { RowFlex } from './dataset/enum/Row';
@@ -40,24 +40,82 @@ import { AreaMode } from './dataset/enum/Area';
 import { IBadge } from './interface/Badge';
 import { WatermarkType } from './dataset/enum/Watermark';
 import { INTERNAL_SHORTCUT_KEY } from './dataset/constant/Shortcut';
+/**
+ * Canvas编辑器主类
+ *
+ * 这是编辑器的入口点，提供：
+ * - 编辑器实例创建和销毁
+ * - 命令执行接口（通过command属性）
+ * - 事件监听和事件总线
+ * - 插件扩展机制
+ *
+ * @example
+ * ```typescript
+ * const editor = new Editor(container, data, options);
+ * editor.command.executeBold(); // 执行加粗命令
+ * editor.listener.contentChange = () => { }; // 监听内容变化
+ * editor.destroy(); // 销毁编辑器
+ * ```
+ */
 export default class Editor {
+    /** 命令执行器，提供所有编辑操作的接口 */
     command: Command;
+    /** 编辑器版本号 */
     version: string;
+    /** 事件监听器，用于设置各种回调函数 */
     listener: Listener;
+    /** 事件总线，用于发布/订阅编辑器事件 */
     eventBus: EventBus<EventBusMap>;
+    /** 覆盖器，用于自定义内部行为 */
     override: Override;
+    /** 注册器，用于注册自定义菜单、快捷键等 */
     register: Register;
+    /** 销毁编辑器的方法 */
     destroy: () => void;
+    /** 插件使用方法 */
     use: UsePlugin;
+    /** 核心渲染引擎 */
     private draw;
+    /**
+     * 创建编辑器实例
+     *
+     * @param container - 编辑器容器元素
+     * @param data - 编辑器数据，可以是元素数组或包含header/main/footer的对象
+     * @param options - 编辑器配置选项
+     */
     constructor(container: HTMLDivElement, data: IEditorData | IElement[], options?: IEditorOption);
+    /**
+     * 设置表单模式追踪选项
+     * @param payload - 表单模式追踪配置
+     */
     setFormModeTrace(payload: IFormModeTraceOption): void;
+    /**
+     * 暂停用户交互
+     *
+     * 调用后编辑器将不响应用户输入事件。
+     */
     pauseInteraction(): void;
+    /**
+     * 恢复用户交互
+     *
+     * 恢复编辑器对用户输入事件的响应。
+     */
     resumeInteraction(): void;
+    /**
+     * 设置覆盖层激活状态
+     *
+     * 当外部模态框、下拉菜单等覆盖层打开时调用。
+     *
+     * @param payload - 是否激活
+     */
     setOverlayActive(payload: boolean): void;
+    /**
+     * 暂停/恢复全局快捷键
+     * @param payload - true暂停，false恢复
+     */
     suspendGlobalShortcut(payload: boolean): void;
 }
 export { splitText, createDomFromElementList, getElementListByHTML, getTextFromElementList };
 export { EDITOR_COMPONENT, LETTER_CLASS, INTERNAL_CONTEXT_MENU_KEY, INTERNAL_SHORTCUT_KEY, EDITOR_CLIPBOARD };
 export { Editor, RowFlex, VerticalAlign, EditorZone, EditorMode, ElementType, ControlType, EditorComponent, PageMode, RenderMode, ImageDisplay, Command, KeyMap, BlockType, PaperDirection, TableBorder, TdBorder, TdSlash, MaxHeightRatio, NumberType, TitleLevel, ListType, ListStyle, WordBreak, ControlIndentation, ControlComponent, BackgroundRepeat, BackgroundSize, TextDecorationStyle, LineNumberType, LocationPosition, AreaMode, ControlState, FlexDirection, WatermarkType };
-export type { IElement, IEditorData, IEditorOption, IEditorResult, IFormModeTraceOption, IContextMenuContext, IRegisterContextMenu, IWatermark, INavigateInfo, IBlock, ILang, ICatalog, ICatalogItem, IRange, IRangeStyle, IBadge, IGetElementListByHTMLOption, IMacroConfig, IMacroElement, IGetMacroValueOption, IMacroValueResult, ISetMacroValueOption, IUpdateMacroPropertiesOption, ISubTemplateElement };
+export type { IElement, IEditorData, IEditorOption, IEditorResult, IFormModeTraceOption, IContextMenuContext, IRegisterContextMenu, IWatermark, INavigateInfo, IBlock, ILang, ICatalog, ICatalogItem, IRange, IRangeStyle, IBadge, IGetElementListByHTMLOption, IMacroConfig, IMacroElement, ILogicTemplateDisplayRule, ILogicTemplateElement, IGetMacroValueOption, IMacroValueResult, ISetMacroValueOption, IUpdateMacroPropertiesOption, ISubTemplateElement };

package/dist/src/editor/interface/Element.d.ts

@@ -16,6 +16,7 @@ import { ITitle } from './Title';
 import { IColgroup } from './table/Colgroup';
 import { ITr } from './table/Tr';
 import { VerticalAlign } from '../dataset/enum/VerticalAlign';
+import { EditorMode } from '../dataset/enum/Editor';
 export interface IElementBasic {
     id?: string;
     type?: ElementType;
@@ -256,6 +257,31 @@ export interface IReusableItemElement {
     /** 复用项目配置 */
     reusableItemConfig?: IReusableItemConfig;
 }
+export type LogicTemplateValueSource = 'auto' | 'control' | 'macro';
+export interface ILogicTemplateDisplayRule {
+    /** 用于匹配值的字段，默认按控件 label / 宏 label / dictCode / 元素 id 自动查找 */
+    field: string;
+    /** 正则表达式字符串 */
+    regexp: string;
+    /** 正则标志，例如 i、g */
+    flags?: string;
+    /** 取值来源，默认 auto */
+    source?: LogicTemplateValueSource;
+    /** 生效模式，默认 [FORM, PRINT] */
+    modes?: Array<EditorMode.FORM | EditorMode.PRINT>;
+}
+export interface ILogicTemplateElement {
+    /** 逻辑模板分组 ID */
+    logicTemplateId?: string;
+    /** 逻辑模板名称 */
+    logicTemplateName?: string;
+    /** 逻辑模板引用的模板 ID */
+    logicTemplateTemplateId?: string;
+    /** 显示规则 */
+    logicTemplateDisplayRule?: ILogicTemplateDisplayRule;
+    /** 当前模式下是否被逻辑模板规则隐藏 */
+    logicTemplateHidden?: boolean;
+}
 /**
  * 子模板元素属性接口
  * Sub template element properties interface
@@ -268,7 +294,7 @@ export interface ISubTemplateElement {
     /** 子模板是否展开（表单模式下使用） */
     subTemplateExpanded?: boolean;
 }
-export type IElement = IElementBasic & IElementStyle & IElementRule & IElementGroup & ITable & IHyperlinkElement & ISuperscriptSubscript & ISeparator & IControlElement & ICheckboxElement & IRadioElement & ILaTexElement & IDateElement & IImageElement & IBlockElement & ITitleElement & IListElement & IAreaElement & ILabelElement & IMenstrualHistoryElement & IFetalHeartPositionElement & IToothPositionElement & IMacroElement & IReusableItemElement & ISubTemplateElement;
+export type IElement = IElementBasic & IElementStyle & IElementRule & IElementGroup & ITable & IHyperlinkElement & ISuperscriptSubscript & ISeparator & IControlElement & ICheckboxElement & IRadioElement & ILaTexElement & IDateElement & IImageElement & IBlockElement & ITitleElement & IListElement & IAreaElement & ILabelElement & IMenstrualHistoryElement & IFetalHeartPositionElement & IToothPositionElement & IMacroElement & IReusableItemElement & ILogicTemplateElement & ISubTemplateElement;
 export interface IElementMetrics {
     width: number;
     height: number;

package/dist/src/editor/utils/element.d.ts

@@ -69,5 +69,7 @@ export declare function getIsBlockElement(element?: IElement): boolean;
 export declare function replaceHTMLElementTag(oldDom: HTMLElement, tagName: keyof HTMLElementTagNameMap): HTMLElement;
 export declare function pickSurroundElementList(elementList: IElement[]): IElement[];
 export declare function deleteSurroundElementList(elementList: IElement[], pageNo: number): void;
+export declare function isElementHidden(element?: IElement | null): boolean;
+export declare function isElementVisible(element?: IElement | null): boolean;
 export declare function getNonHideElementIndex(elementList: IElement[], index: number, position?: LocationPosition): number;
 export {};

package/dist/src/editor/utils/logicTemplate.d.ts

@@ -0,0 +1,9 @@
+import { EditorMode } from '../dataset/enum/Editor';
+import { IElement, ILogicTemplateDisplayRule, ILogicTemplateElement } from '../interface/Element';
+export declare const LOGIC_TEMPLATE_DEFAULT_MODES: readonly [EditorMode.FORM, EditorMode.PRINT];
+export interface ILogicTemplateMeta extends Pick<ILogicTemplateElement, 'logicTemplateId' | 'logicTemplateName' | 'logicTemplateTemplateId' | 'logicTemplateDisplayRule'> {
+}
+export declare function visitLogicTemplateElements(elementList: IElement[], visitor: (element: IElement) => void): void;
+export declare function applyLogicTemplateMeta(elementList: IElement[], meta: ILogicTemplateMeta): void;
+export declare function collectLogicTemplateList(elementList: IElement[]): ILogicTemplateElement[];
+export declare function isLogicTemplateModeMatched(rule: ILogicTemplateDisplayRule | undefined, mode: EditorMode): boolean;

package/package.json

@@ -2,7 +2,7 @@
   "name": "ht-emr",
   "author": "swj",
   "license": "MIT",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "rich text editor by canvas/svg",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",