@hufe921/canvas-editor 0.9.137 → 1.0.0

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

@@ -0,0 +1,5 @@
+import { IElement } from './Element';
+export interface IComparePayload {
+    oldData: IElement[];
+    newData?: IElement[];
+}

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

@@ -56,6 +56,7 @@ export interface IControlRule {
     disabled?: boolean;
     pasteDisabled?: boolean;
     hide?: boolean;
+    required?: boolean;
 }
 export interface IControlBasic {
     type: ControlType;
@@ -73,6 +74,9 @@ export interface IControlBasic {
     rowFlex?: RowFlex;
     preText?: string;
     postText?: string;
+    cascade?: IControlCascadeRule[];
+    validation?: IControlValidation;
+    compute?: string;
 }
 export interface IControlStyle {
     font?: string;
@@ -94,6 +98,7 @@ export interface IControlOption {
     disabledBackgroundColor?: string;
     existValueBackgroundColor?: string;
     noValueBackgroundColor?: string;
+    errorBackgroundColor?: string;
 }
 export interface IControlInitOption {
     index: number;
@@ -196,3 +201,44 @@ export interface IRemoveControlOption {
     id?: string;
     conceptId?: string;
 }
+export type CascadeTargetType = 'control' | 'title';
+export interface ICascadeAction {
+    controlId?: string;
+    conceptId?: string;
+    targetType?: CascadeTargetType;
+    effects: {
+        hide?: boolean;
+        required?: boolean;
+        disabled?: boolean;
+        deletable?: boolean;
+    };
+}
+export interface IControlCascadeRule {
+    expression: string;
+    actions: ICascadeAction[];
+    elseActions?: ICascadeAction[];
+}
+export interface IControlValidation {
+    minLength?: number;
+    maxLength?: number;
+    pattern?: string;
+    min?: number;
+    max?: number;
+    integer?: boolean;
+    precision?: number;
+    minDate?: string;
+    maxDate?: string;
+    minChecked?: number;
+    maxChecked?: number;
+    message?: string;
+}
+export interface IValidateOption {
+    zone?: EditorZone;
+    errorBackgroundColor?: string;
+}
+export interface IControlValidateResult {
+    controlId: string;
+    conceptId?: string;
+    control: IControl;
+    errors: string[];
+}

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

@@ -34,6 +34,7 @@ export interface IDrawRowPayload {
     zone?: EditorZone;
     isDrawLineBreak?: boolean;
     isDrawWhiteSpace?: boolean;
+    isDrawRange?: boolean;
 }
 export interface IDrawFloatPayload {
     pageNo: number;

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

@@ -30,6 +30,8 @@ import { IGraffitiData, IGraffitiOption } from './Graffiti';
 import { IWhiteSpaceOption } from './WhiteSpace';
 import { IMagnifierOption } from './Magnifier';
 import { IAccessibilityOption } from './Accessibility';
+import { ITraceOption } from './Trace';
+import { IRulerOption } from './Ruler';
 export interface IEditorData {
     header?: IElement[];
     main: IElement[];
@@ -110,6 +112,8 @@ export interface IEditorOption {
     magnifier?: IMagnifierOption;
     accessibility?: IAccessibilityOption;
     column?: IColumnOption;
+    trace?: ITraceOption;
+    ruler?: IRulerOption;
 }
 export interface IEditorResult {
     version: string;
@@ -136,7 +140,6 @@ export interface IPrintModeRule {
     imagePreviewerDisabled?: boolean;
     backgroundDisabled?: boolean;
     filterEmptyControl?: boolean;
-    filterHideElementRow?: boolean;
     areaHideDisabled?: boolean;
 }
 export interface IReadonlyModeRule {

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

@@ -1,6 +1,7 @@
 import { ImageDisplay } from '../dataset/enum/Common';
 import { ControlComponent } from '../dataset/enum/Control';
 import { ElementType } from '../dataset/enum/Element';
+import { TraceType } from '../dataset/enum/Trace';
 import { ListStyle, ListType } from '../dataset/enum/List';
 import { RowFlex } from '../dataset/enum/Row';
 import { TitleLevel } from '../dataset/enum/Title';
@@ -14,6 +15,7 @@ import { IRadio } from './Radio';
 import { ITextDecoration } from './Text';
 import { ITitle } from './Title';
 import { IColgroup } from './table/Colgroup';
+import { ITd } from './table/Td';
 import { ITr } from './table/Tr';
 export interface IElementBasic {
     id?: string;
@@ -46,6 +48,14 @@ export interface IElementRule {
 export interface IElementGroup {
     groupIds?: string[];
 }
+export interface ITraceRecord {
+    type: TraceType;
+    author?: string;
+    timestamp?: number;
+}
+export interface IElementTrace {
+    trace?: ITraceRecord[];
+}
 export interface ITitleElement {
     valueList?: IElement[];
     level?: TitleLevel;
@@ -58,6 +68,7 @@ export interface IListElement {
     listStyle?: ListStyle;
     listId?: string;
     listWrap?: boolean;
+    listLevel?: number;
 }
 export interface ITableAttr {
     colgroup?: IColgroup[];
@@ -76,8 +87,6 @@ export interface ITableElement {
     trId?: string;
     tableId?: string;
     conceptId?: string;
-    pagingId?: string;
-    pagingIndex?: number;
 }
 export type ITable = ITableAttr & ITableRule & ITableElement;
 export interface IHyperlinkElement {
@@ -166,7 +175,7 @@ export interface ILabelElement {
         padding?: IPadding;
     };
 }
-export type IElement = IElementBasic & IElementStyle & IElementRule & IElementGroup & ITable & IHyperlinkElement & ISuperscriptSubscript & ISeparator & IControlElement & ICheckboxElement & IRadioElement & ILaTexElement & IDateElement & IImageElement & IBlockElement & ITitleElement & IListElement & IAreaElement & ILabelElement;
+export type IElement = IElementBasic & IElementStyle & IElementRule & IElementGroup & IElementTrace & ITable & IHyperlinkElement & ISuperscriptSubscript & ISeparator & IControlElement & ICheckboxElement & IRadioElement & ILaTexElement & IDateElement & IImageElement & IBlockElement & ITitleElement & IListElement & IAreaElement & ILabelElement;
 export interface IElementMetrics {
     width: number;
     height: number;
@@ -186,6 +195,7 @@ export interface IElementPosition {
     isFirstLetter: boolean;
     isLastLetter: boolean;
     columnIndex?: number;
+    tableFragment?: ITableRowFragment;
     coordinate: {
         leftTop: number[];
         leftBottom: number[];
@@ -193,6 +203,16 @@ export interface IElementPosition {
         rightBottom: number[];
     };
 }
+export interface ITableRowFragment {
+    startTrIndex: number;
+    endTrIndex: number;
+    skipHeight: number;
+    repeatHeight: number;
+    repeatTrIndexes?: number[];
+    startSplitTrOffset?: number;
+    endSplitTrHeight?: number;
+    carriedTds?: ITd[];
+}
 export interface IElementFillRect {
     x: number;
     y: number;

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

@@ -0,0 +1,19 @@
+import { MacroType } from '../dataset/enum/Macro';
+export interface IMacroStep {
+    command: string;
+    args: unknown[];
+}
+export interface IRecordedMacro {
+    id: string;
+    name: string;
+    type: MacroType.RECORDED;
+    steps: IMacroStep[];
+}
+export type IMacroHandler = (...args: unknown[]) => void | Promise<void>;
+export interface IScriptMacro {
+    id: string;
+    name: string;
+    type: MacroType.SCRIPT;
+    handler: IMacroHandler;
+}
+export type IMacro = IRecordedMacro | IScriptMacro;

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

@@ -1,5 +1,6 @@
 import { RowFlex } from '../dataset/enum/Row';
-import { IElement, IElementMetrics } from './Element';
+import { IElement, IElementMetrics, IElementPosition, ITableRowFragment } from './Element';
+import { ITd } from './table/Td';
 export type IRowElement = IElement & {
     metrics: IElementMetrics;
     style: string;
@@ -21,4 +22,10 @@ export interface IRow {
     rowIndex: number;
     isSurround?: boolean;
     columnIndex?: number;
+    tableFragment?: ITableRowFragment;
+    fragmentPosition?: IElementPosition;
+    repeatTdPositionList?: {
+        td: ITd;
+        positionList: IElementPosition[];
+    }[];
 }

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

@@ -0,0 +1,4 @@
+export interface IRulerOption {
+    disabled?: boolean;
+    height?: number;
+}

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

@@ -0,0 +1,11 @@
+export interface ITraceOption {
+    disabled?: boolean;
+    insertColor?: string;
+    deleteColor?: string;
+    author?: string;
+    lineWidth?: number;
+}
+export interface IMarkElementListDeletedOption {
+    isIgnoreDeletedRule?: boolean;
+    tdDeletable?: boolean;
+}

package/dist/src/editor/interface/i18n/I18n.d.ts

@@ -1,8 +1,12 @@
 import { IDatePickerLang } from '../../core/draw/particle/date/DatePicker';
 import { IContextmenuLang } from '../contextmenu/ContextMenu';
 import { IAccessibilityLang } from './Accessibility';
+import { ITraceLang } from './Trace';
+import { IValidateLang } from './Validate';
 export interface ILang {
     contextmenu: IContextmenuLang;
     datePicker: IDatePickerLang;
     accessibility: IAccessibilityLang;
+    trace: ITraceLang;
+    validate: IValidateLang;
 }

package/dist/src/editor/interface/i18n/Trace.d.ts

@@ -0,0 +1,7 @@
+export interface ITraceLang {
+    insert: string;
+    delete: string;
+    author: string;
+    time: string;
+    unknownAuthor: string;
+}

package/dist/src/editor/interface/i18n/Validate.d.ts

@@ -0,0 +1,15 @@
+export interface IValidateLang {
+    required: string;
+    minLength: string;
+    maxLength: string;
+    pattern: string;
+    invalidNumber: string;
+    min: string;
+    max: string;
+    integer: string;
+    precision: string;
+    minDate: string;
+    maxDate: string;
+    minChecked: string;
+    maxChecked: string;
+}

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

@@ -0,0 +1,7 @@
+import { IElement } from '../interface/Element';
+export interface IDiffOp {
+    type: 'equal' | 'insert' | 'delete';
+    value: string;
+}
+export declare function diffText(oldText: string, newText: string): IDiffOp[];
+export declare function compareElementList(oldList: IElement[], newList: IElement[]): IElement[];

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

@@ -3,6 +3,9 @@ import { RowFlex } from '../dataset/enum/Row';
 import { DeepRequired } from '../interface/Common';
 import { IEditorOption } from '../interface/Editor';
 import { IElement } from '../interface/Element';
+export declare function isElementTraceDeleted(element: IElement): boolean;
+export declare function getNonDeletedElementList(elementList: IElement[]): IElement[];
+export declare function getNonTraceElementList(elementList: IElement[]): IElement[];
 export declare function unzipElementList(elementList: IElement[]): IElement[];
 interface IFormatElementListOption {
     isHandleFirstElement?: boolean;
@@ -19,6 +22,7 @@ interface IZipElementListOption {
     extraPickAttrs?: Array<keyof IElement>;
     isClassifyArea?: boolean;
     isClone?: boolean;
+    isListValue?: boolean;
 }
 export declare function zipElementList(payload: IElement[], options?: IZipElementListOption): IElement[];
 export declare function convertTextAlignToRowFlex(node: HTMLElement): RowFlex;
@@ -47,11 +51,26 @@ export interface IGetElementListByHTMLOption {
     innerWidth: number;
 }
 export declare function getElementListByHTML(htmlText: string, options: IGetElementListByHTMLOption): IElement[];
-export declare function getTextFromElementList(elementList: IElement[]): string;
+export declare function getTextFromElementList(elementList: IElement[], options?: {
+    isClone?: boolean;
+}): string;
 export declare function getSlimCloneElementList(elementList: IElement[]): IElement[];
 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 getNonHideElementIndex(elementList: IElement[], index: number, position?: LocationPosition): number;
+export declare function getNonHideElementIndex(elementList: IElement[], index: number, position?: LocationPosition, isHidden?: (element: IElement) => boolean): number;
+/**
+ * 嵌套感知的边界步进：从 index 按方向移动一位。
+ * 若落点 controlId 与 ownerId 相同，返回落点；
+ * 若落点 controlId 不同（进入了内层控件段），持续同向步进直到回到 ownerId 或越界。
+ * 用于替换边界扫描循环里的 i++ / i--。
+ */
+export declare function scanToOwner(elementList: IElement[], index: number, direction: 1 | -1, ownerId: string): number;
+/**
+ * 查找位置所属的最外层控件 controlId。
+ * 通过向左扫找到当前控件的 PREFIX，递归检查 PREFIX 前一位是否仍在另一控件段内。
+ */
+export declare function getOutermostOwner(elementList: IElement[], index: number): string | null;
+export declare function visitElementTree(elementList: IElement[], visitor: (element: IElement) => void): void;
 export {};

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

@@ -0,0 +1,4 @@
+import { IColgroup } from '../interface/table/Colgroup';
+export declare function getColgroupWidth(colgroup: IColgroup[]): number;
+export declare function shrinkColgroupToWidth(colgroup: IColgroup[], maxWidth: number, minWidth: number): void;
+export declare function scaleColgroupToWidth(colgroup: IColgroup[], targetWidth: number): void;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@hufe921/canvas-editor",
   "author": "Hufe",
   "license": "MIT",
-  "version": "0.9.137",
+  "version": "1.0.0",
   "description": "A Canvas/SVG-based rich text editor",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",