ht-emr 0.6.2 → 0.6.3

package/dist/src/editor/core/command/Command.d.ts

@@ -163,5 +163,8 @@ export declare class Command {
     expandSubTemplate: CommandAdapt['expandSubTemplate'];
     collapseSubTemplate: CommandAdapt['collapseSubTemplate'];
     toggleSubTemplate: CommandAdapt['toggleSubTemplate'];
+    insertLogicTemplate: CommandAdapt['insertLogicTemplate'];
+    updateLogicTemplate: CommandAdapt['updateLogicTemplate'];
+    getLogicTemplateList: CommandAdapt['getLogicTemplateList'];
     constructor(adapt: CommandAdapt);
 }

package/dist/src/editor/core/command/CommandAdapt.d.ts

@@ -13,7 +13,7 @@ import { DeepRequired } from '../../interface/Common';
 import { IGetControlValueOption, IGetControlValueResult, ILocationControlOption, IRemoveControlOption, ISetControlExtensionOption, ISetControlHighlightOption, ISetControlProperties, ISetControlValueOption } from '../../interface/Control';
 import { IAppendElementListOption, IDrawImagePayload, IForceUpdateOption, IGetImageOption, IGetValueOption, IPainterOption } from '../../interface/Draw';
 import { IEditorData, IEditorHTML, IEditorOption, IFormModeTraceOption, IEditorResult, IEditorText, IFocusOption, ISetValueOption, IUpdateOption } from '../../interface/Editor';
-import { IDeleteElementByIdOption, IElement, IElementPosition, IGetElementByIdOption, IGetMacroValueOption, IImageCaption, IImageCrop, IInsertElementListOption, IMacroValueResult, ISetMacroValueOption, IUpdateElementByIdOption, IUpdateMacroPropertiesOption } from '../../interface/Element';
+import { IDeleteElementByIdOption, IElement, IElementPosition, IGetElementByIdOption, ILogicTemplateDisplayRule, ILogicTemplateElement, IGetMacroValueOption, IImageCaption, IImageCrop, IInsertElementListOption, IMacroValueResult, ISetMacroValueOption, IUpdateElementByIdOption, IUpdateMacroPropertiesOption } from '../../interface/Element';
 import { ICopyOption, IPasteOption, IPositionContextByEventOption, IPositionContextByEventResult } from '../../interface/Event';
 import { IMargin } from '../../interface/Margin';
 import { IRange, RangeContext } from '../../interface/Range';
@@ -298,4 +298,39 @@ export declare class CommandAdapt {
         /** 是否提交历史 */
         isSubmitHistory?: boolean;
     }): void;
+    /**
+     * 插入逻辑模板
+     * Insert logic template content directly with display rule metadata
+     */
+    insertLogicTemplate(payload: {
+        /** 逻辑模板名称 */
+        label: string;
+        /** 逻辑模板引用的模板 ID */
+        templateId: string;
+        /** 模板内容 */
+        content: IElement[];
+        /** 显示规则 */
+        displayRule?: ILogicTemplateDisplayRule;
+        /** 是否提交历史 */
+        isSubmitHistory?: boolean;
+    }): string | null;
+    /**
+     * 更新逻辑模板元数据
+     * Update logic template metadata for the whole group
+     */
+    updateLogicTemplate(payload: {
+        /** 逻辑模板 ID */
+        logicTemplateId?: string;
+        /** 逻辑模板内任意元素 ID */
+        id?: string;
+        /** 要更新的属性 */
+        properties: Partial<Omit<ILogicTemplateElement, 'logicTemplateId' | 'logicTemplateHidden'>>;
+        /** 是否提交历史 */
+        isSubmitHistory?: boolean;
+    }): void;
+    /**
+     * 获取逻辑模板列表
+     * Get all logic template groups
+     */
+    getLogicTemplateList(): ILogicTemplateElement[];
 }

package/dist/src/editor/core/cursor/Cursor.d.ts

@@ -3,39 +3,139 @@ import { ICursorOption } from '../../interface/Cursor';
 import { IElementPosition } from '../../interface/Element';
 import { Draw } from '../draw/Draw';
 import { CanvasEvent } from '../event/CanvasEvent';
+/**
+ * 绘制光标的配置选项
+ * @extends ICursorOption
+ */
 export type IDrawCursorOption = ICursorOption & {
+    /** 是否显示光标 */
     isShow?: boolean;
+    /** 是否启用闪烁动画 */
     isBlink?: boolean;
+    /** 是否聚焦到代理输入框 */
     isFocus?: boolean;
+    /** 点击行首时的起始索引 */
     hitLineStartIndex?: number;
 };
+/**
+ * 移动光标到可视区域的配置选项
+ */
 export interface IMoveCursorToVisibleOption {
+    /** 移动方向 */
     direction: MoveDirection;
+    /** 光标位置信息 */
     cursorPosition: IElementPosition;
 }
+/**
+ * 光标管理类
+ *
+ * 负责编辑器中光标的绘制、显示和位置管理。
+ * 光标是文本编辑器中指示当前输入位置的视觉元素，支持闪烁动画、
+ * 自动滚动到可视区域等功能。
+ */
 export declare class Cursor {
+    /** 光标闪烁动画的CSS类名 */
     private readonly ANIMATION_CLASS;
+    /** Draw实例，用于获取渲染上下文和状态 */
     private draw;
+    /** 编辑器容器元素 */
     private container;
+    /** 编辑器配置选项 */
     private options;
+    /** 位置管理器，用于获取光标位置 */
     private position;
+    /** 光标DOM元素 */
     private cursorDom;
+    /** 光标代理，用于处理输入事件 */
     private cursorAgent;
+    /** 闪烁定时器ID */
     private blinkTimeout;
+    /** 点击行首时的起始索引 */
     private hitLineStartIndex;
+    /**
+     * 创建光标管理器实例
+     * @param draw - Draw实例，用于获取渲染上下文
+     * @param canvasEvent - CanvasEvent实例，用于处理事件
+     */
     constructor(draw: Draw, canvasEvent: CanvasEvent);
+    /**
+     * 获取光标DOM元素
+     * @returns 光标的DOM元素
+     */
     getCursorDom(): HTMLDivElement;
+    /**
+     * 获取代理输入框DOM元素
+     * @returns 代理输入框的textarea元素
+     */
     getAgentDom(): HTMLTextAreaElement;
+    /**
+     * 检查代理输入框是否处于激活状态
+     * @returns 如果代理输入框是当前激活元素则返回true
+     */
     getAgentIsActive(): boolean;
+    /**
+     * 获取代理输入框的值
+     * @returns 代理输入框中的文本内容
+     */
     getAgentDomValue(): string;
+    /**
+     * 清空代理输入框的值
+     */
     clearAgentDomValue(): void;
+    /**
+     * 获取点击行首时的起始索引
+     * @returns 行首索引，如果未设置则返回undefined
+     */
     getHitLineStartIndex(): number | undefined;
+    /**
+     * 开始光标闪烁动画
+     * @private
+     */
     private _blinkStart;
+    /**
+     * 停止光标闪烁动画
+     * @private
+     */
     private _blinkStop;
+    /**
+     * 设置闪烁定时器
+     * @private
+     */
     private _setBlinkTimeout;
+    /**
+     * 清除闪烁定时器
+     * @private
+     */
     private _clearBlinkTimeout;
+    /**
+     * 聚焦到代理输入框
+     *
+     * 在移动端只读模式下禁用聚焦以避免唤起输入法，
+     * 在web端允许聚焦以确保键盘事件能够被捕获。
+     */
     focus(): void;
+    /**
+     * 绘制光标
+     *
+     * 根据当前光标位置绘制光标，支持自定义光标样式和动画。
+     * 光标会自动调整位置和大小以适应当前字体。
+     *
+     * @param payload - 绘制光标的配置选项
+     */
     drawCursor(payload?: IDrawCursorOption): void;
+    /**
+     * 隐藏光标
+     *
+     * 将光标从视图中移除并停止闪烁动画
+     */
     recoveryCursor(): void;
+    /**
+     * 将光标移动到可视区域
+     *
+     * 当光标位置超出当前可视区域时，自动滚动页面以确保光标可见。
+     * 支持向上和向下两种滚动方向。
+     *
+     * @param payload - 移动配置选项
+     */
     moveCursorToVisible(payload: IMoveCursorToVisibleOption): void;
 }

package/dist/src/editor/core/cursor/CursorAgent.d.ts

@@ -1,18 +1,97 @@
 import { Draw } from '../draw/Draw';
 import { CanvasEvent } from '../event/CanvasEvent';
+/**
+ * 光标代理类
+ *
+ * 光标代理是一个隐藏的textarea元素，用于捕获用户输入事件。
+ * 由于Canvas无法直接接收文本输入，需要通过代理元素来处理：
+ * - 键盘输入事件
+ * - 输入法组合事件（中文输入等）
+ * - 粘贴事件
+ */
 export declare class CursorAgent {
+    /** Draw实例，用于获取渲染上下文和状态 */
     private draw;
+    /** 编辑器容器元素 */
     private container;
+    /** 代理输入框DOM元素 */
     private agentCursorDom;
+    /** Canvas事件处理器 */
     private canvasEvent;
+    /** 事件总线，用于发布/订阅事件 */
     private eventBus;
+    /**
+     * 创建光标代理实例
+     * @param draw - Draw实例，用于获取渲染上下文
+     * @param canvasEvent - CanvasEvent实例，用于处理事件
+     */
     constructor(draw: Draw, canvasEvent: CanvasEvent);
+    /**
+     * 获取代理输入框DOM元素
+     * @returns 代理输入框的textarea元素
+     */
     getAgentCursorDom(): HTMLTextAreaElement;
+    /**
+     * 处理键盘按下事件
+     * @param evt - 键盘事件对象
+     * @private
+     */
     private _keyDown;
+    /**
+     * 处理输入事件
+     *
+     * 当用户输入文本时触发，将输入数据传递给CanvasEvent处理。
+     * 同时发布input事件到事件总线。
+     *
+     * @param evt - 输入事件对象
+     * @private
+     */
     private _input;
+    /**
+     * 处理粘贴事件
+     *
+     * 当用户粘贴内容时触发，将粘贴操作委托给pasteByEvent处理函数。
+     * 在只读模式下忽略粘贴操作。
+     *
+     * @param evt - 剪贴板事件对象
+     * @private
+     */
     private _paste;
+    /**
+     * 处理输入法组合开始事件
+     *
+     * 当用户开始使用输入法（如中文输入法）时触发。
+     * 此时会调整代理输入框的样式以显示输入法候选词。
+     *
+     * @private
+     */
     private _compositionstart;
+    /**
+     * 处理输入法组合更新事件
+     *
+     * 当输入法组合内容发生变化时触发。
+     * 动态调整代理输入框宽度以适应输入内容。
+     *
+     * @private
+     */
     private _compositionupdate;
+    /**
+     * 处理输入法组合结束事件
+     *
+     * 当输入法组合完成时触发，将最终文本插入到文档中。
+     * 恢复代理输入框的样式。
+     *
+     * @param evt - 组合事件对象
+     * @private
+     */
     private _compositionend;
+    /**
+     * 处理键盘按下事件（用于取消输入法组合）
+     *
+     * 当用户按下Escape键时，取消当前的输入法组合。
+     *
+     * @param evt - 键盘事件对象
+     * @private
+     */
     private _keydown;
 }