editor-svg 1.0.2 → 1.0.3

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

@@ -0,0 +1,57 @@
+import { AreaMode } from '../dataset/enum/Area';
+import { LocationPosition } from '../dataset/enum/Common';
+import { IElement, IElementPosition } from './Element';
+import { IPlaceholder } from './Placeholder';
+import { IRange } from './Range';
+export interface IAreaBasic {
+    extension?: unknown;
+    placeholder?: IPlaceholder;
+}
+export interface IAreaStyle {
+    top?: number;
+    borderColor?: string;
+    backgroundColor?: string;
+    borderWidth?: number;
+    padding?: number[];
+}
+export interface IAreaRule {
+    mode?: AreaMode;
+    hide?: boolean;
+    deletable?: boolean;
+}
+export type IArea = IAreaBasic & IAreaStyle & IAreaRule;
+export interface IInsertAreaOption {
+    id?: string;
+    area: IArea;
+    value: IElement[];
+    position?: LocationPosition;
+    range?: Pick<IRange, 'startIndex' | 'endIndex'>;
+}
+export interface ISetAreaValueOption {
+    id?: string;
+    value: IElement[];
+}
+export interface ISetAreaPropertiesOption {
+    id?: string;
+    properties: IArea;
+}
+export interface IGetAreaValueOption {
+    id?: string;
+}
+export interface IGetAreaValueResult {
+    id?: string;
+    area: IArea;
+    startPageNo: number;
+    endPageNo: number;
+    value: IElement[];
+}
+export interface IAreaInfo {
+    id: string;
+    area: IArea;
+    elementList: IElement[];
+    positionList: IElementPosition[];
+}
+export interface ILocationAreaOption {
+    position: LocationPosition;
+    isAppendLastLineBreak?: boolean;
+}

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

@@ -0,0 +1,8 @@
+import { BackgroundRepeat, BackgroundSize } from '../dataset/enum/Background';
+export interface IBackgroundOption {
+    color?: string;
+    image?: string;
+    size?: BackgroundSize;
+    repeat?: BackgroundRepeat;
+    applyPageNumbers?: number[];
+}

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

@@ -0,0 +1,15 @@
+export interface IBadge {
+    top?: number;
+    left?: number;
+    width: number;
+    height: number;
+    value: string;
+}
+export interface IBadgeOption {
+    top?: number;
+    left?: number;
+}
+export interface IAreaBadge {
+    areaId: string;
+    badge: IBadge;
+}

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

@@ -0,0 +1,15 @@
+import { BlockType } from '../dataset/enum/Block';
+export interface IIFrameBlock {
+    src?: string;
+    srcdoc?: string;
+    sandbox?: string[];
+    allow?: string[];
+}
+export interface IVideoBlock {
+    src: string;
+}
+export interface IBlock {
+    type: BlockType;
+    iframeBlock?: IIFrameBlock;
+    videoBlock?: IVideoBlock;
+}

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

@@ -0,0 +1,9 @@
+import { TitleLevel } from '../dataset/enum/Title';
+export interface ICatalogItem {
+    id: string;
+    name: string;
+    level: TitleLevel;
+    pageNo: number;
+    subCatalog: ICatalogItem[];
+}
+export type ICatalog = ICatalogItem[];

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

@@ -0,0 +1,15 @@
+import { VerticalAlign } from '../dataset/enum/VerticalAlign';
+export interface ICheckbox {
+    value: boolean | null;
+    code?: string;
+    disabled?: boolean;
+}
+export interface ICheckboxOption {
+    width?: number;
+    height?: number;
+    gap?: number;
+    lineWidth?: number;
+    fillStyle?: string;
+    strokeStyle?: string;
+    verticalAlign?: VerticalAlign;
+}

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

@@ -0,0 +1,3 @@
+export interface IRichtextOption {
+    isIgnoreDisabledRule: boolean;
+}

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

@@ -0,0 +1,14 @@
+export type Primitive = string | number | boolean | bigint | symbol | undefined | null;
+export type Builtin = Primitive | Function | Date | Error | RegExp;
+export type DeepRequired<T> = T extends Error ? Required<T> : T extends Builtin ? T : T extends Map<infer K, infer V> ? Map<DeepRequired<K>, DeepRequired<V>> : T extends ReadonlyMap<infer K, infer V> ? ReadonlyMap<DeepRequired<K>, DeepRequired<V>> : T extends WeakMap<infer K, infer V> ? WeakMap<DeepRequired<K>, DeepRequired<V>> : T extends Set<infer U> ? Set<DeepRequired<U>> : T extends ReadonlySet<infer U> ? ReadonlySet<DeepRequired<U>> : T extends WeakSet<infer U> ? WeakSet<DeepRequired<U>> : T extends Promise<infer U> ? Promise<DeepRequired<U>> : T extends {} ? {
+    [K in keyof T]-?: DeepRequired<T[K]>;
+} : Required<T>;
+export type DeepPartial<T> = {
+    [P in keyof T]?: DeepPartial<T[P]>;
+};
+export type IPadding = [
+    top: number,
+    right: number,
+    bottom: number,
+    left: number
+];

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

@@ -0,0 +1,198 @@
+import { FlexDirection, LocationPosition } from '../dataset/enum/Common';
+import { ControlType, ControlIndentation, ControlState } from '../dataset/enum/Control';
+import { EditorZone } from '../dataset/enum/Editor';
+import { MoveDirection } from '../dataset/enum/Observer';
+import { RowFlex } from '../dataset/enum/Row';
+import { IDrawOption } from './Draw';
+import { IElement } from './Element';
+import { IPositionContext } from './Position';
+import { IRange } from './Range';
+import { IRow, IRowElement } from './Row';
+export interface IValueSet {
+    value: string;
+    code: string;
+}
+export interface IControlSelect {
+    code: string | null;
+    valueSets: IValueSet[];
+    isMultiSelect?: boolean;
+    multiSelectDelimiter?: string;
+    selectExclusiveOptions?: {
+        inputAble?: boolean;
+    };
+}
+export interface IControlCheckbox {
+    code: string | null;
+    min?: number;
+    max?: number;
+    flexDirection: FlexDirection;
+    valueSets: IValueSet[];
+}
+export interface IControlRadio {
+    code: string | null;
+    flexDirection: FlexDirection;
+    valueSets: IValueSet[];
+}
+export interface IControlDate {
+    dateFormat?: string;
+}
+export interface IControlNumber {
+    numberExclusiveOptions?: {
+        calculatorDisabled?: boolean;
+    };
+}
+export interface IControlHighlightRule {
+    keyword: string;
+    alpha?: number;
+    backgroundColor?: string;
+}
+export interface IControlHighlight {
+    ruleList: IControlHighlightRule[];
+    id?: string;
+    conceptId?: string;
+}
+export interface IControlRule {
+    deletable?: boolean;
+    disabled?: boolean;
+    pasteDisabled?: boolean;
+    hide?: boolean;
+}
+export interface IControlBasic {
+    type: ControlType;
+    value: IElement[] | null;
+    placeholder?: string;
+    conceptId?: string;
+    groupId?: string;
+    prefix?: string;
+    postfix?: string;
+    minWidth?: number;
+    underline?: boolean;
+    border?: boolean;
+    extension?: unknown;
+    indentation?: ControlIndentation;
+    rowFlex?: RowFlex;
+    preText?: string;
+    postText?: string;
+}
+export interface IControlStyle {
+    font?: string;
+    size?: number;
+    bold?: boolean;
+    highlight?: string;
+    italic?: boolean;
+    strikeout?: boolean;
+}
+export type IControl = IControlBasic & IControlRule & Partial<IControlStyle> & Partial<IControlSelect> & Partial<IControlCheckbox> & Partial<IControlRadio> & Partial<IControlDate> & Partial<IControlNumber>;
+export interface IControlOption {
+    placeholderColor?: string;
+    bracketColor?: string;
+    prefix?: string;
+    postfix?: string;
+    borderWidth?: number;
+    borderColor?: string;
+    activeBackgroundColor?: string;
+    disabledBackgroundColor?: string;
+    existValueBackgroundColor?: string;
+    noValueBackgroundColor?: string;
+}
+export interface IControlInitOption {
+    index: number;
+    isTable?: boolean;
+    trIndex?: number;
+    tdIndex?: number;
+    tdValueIndex?: number;
+}
+export interface IControlInitResult {
+    newIndex: number;
+}
+export interface IControlInstance {
+    setElement(element: IElement): void;
+    getElement(): IElement;
+    getValue(context?: IControlContext): IElement[];
+    setValue(data: IElement[], context?: IControlContext, options?: IControlRuleOption): number;
+    keydown(evt: KeyboardEvent): number | null;
+    cut(): number;
+}
+export interface IControlContext {
+    range?: IRange;
+    elementList?: IElement[];
+}
+export interface IControlRuleOption {
+    isIgnoreDisabledRule?: boolean;
+    isIgnoreDeletedRule?: boolean;
+    isAddPlaceholder?: boolean;
+}
+export interface IGetControlValueOption {
+    id?: string;
+    groupId?: string;
+    conceptId?: string;
+    areaId?: string;
+}
+export type IGetControlValueResult = (Omit<IControl, 'value'> & {
+    value: string | null;
+    innerText: string | null;
+    zone: EditorZone;
+    elementList?: IElement[];
+})[];
+export interface ISetControlValueOption {
+    id?: string;
+    groupId?: string;
+    conceptId?: string;
+    areaId?: string;
+    value: string | IElement[] | null;
+    isSubmitHistory?: boolean;
+}
+export interface ISetControlExtensionOption {
+    id?: string;
+    groupId?: string;
+    conceptId?: string;
+    areaId?: string;
+    extension: unknown;
+}
+export type ISetControlHighlightOption = IControlHighlight[];
+export type ISetControlProperties = {
+    id?: string;
+    groupId?: string;
+    conceptId?: string;
+    areaId?: string;
+    properties: Partial<Omit<IControl, 'value'>>;
+    isSubmitHistory?: boolean;
+};
+export type IRepaintControlOption = Pick<IDrawOption, 'curIndex' | 'isCompute' | 'isSubmitHistory' | 'isSetCursor'>;
+export interface IControlChangeOption {
+    context?: IControlContext;
+    controlElement?: IElement;
+    controlValue?: IElement[];
+}
+export interface INextControlContext {
+    positionContext: IPositionContext;
+    nextIndex: number;
+}
+export interface IInitNextControlOption {
+    direction?: MoveDirection;
+}
+export interface ILocationControlOption {
+    position: LocationPosition;
+}
+export interface ISetControlRowFlexOption {
+    row: IRow;
+    rowElement: IRowElement;
+    availableWidth: number;
+    controlRealWidth: number;
+}
+export interface IControlChangeResult {
+    state: ControlState;
+    control: IControl;
+    controlId: string;
+}
+export interface IControlContentChangeResult {
+    control: IControl;
+    controlId: string;
+}
+export interface IDestroyControlOption {
+    isEmitEvent?: boolean;
+}
+export interface IRemoveControlOption {
+    id?: string;
+    conceptId?: string;
+}

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

@@ -0,0 +1,7 @@
+export interface ICursorOption {
+    width?: number;
+    color?: string;
+    dragWidth?: number;
+    dragColor?: string;
+    dragFloatImageDisabled?: boolean;
+}

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

@@ -0,0 +1,74 @@
+import { ImageDisplay } from '../dataset/enum/Common';
+import { EditorMode, EditorZone } from '../dataset/enum/Editor';
+import { IElement, IElementPosition } from './Element';
+import { IRow } from './Row';
+export interface IDrawOption {
+    curIndex?: number;
+    isSetCursor?: boolean;
+    isSubmitHistory?: boolean;
+    isCompute?: boolean;
+    isLazy?: boolean;
+    isInit?: boolean;
+    isSourceHistory?: boolean;
+    isFirstRender?: boolean;
+}
+export interface IForceUpdateOption {
+    isSubmitHistory?: boolean;
+}
+export interface IDrawImagePayload {
+    id?: string;
+    conceptId?: string;
+    width: number;
+    height: number;
+    value: string;
+    imgDisplay?: ImageDisplay;
+    extension?: unknown;
+}
+export interface IDrawRowPayload {
+    elementList: IElement[];
+    positionList: IElementPosition[];
+    rowList: IRow[];
+    pageNo: number;
+    startIndex: number;
+    innerWidth: number;
+    zone?: EditorZone;
+    isDrawLineBreak?: boolean;
+    isDrawWhiteSpace?: boolean;
+}
+export interface IDrawFloatPayload {
+    pageNo: number;
+    imgDisplays: ImageDisplay[];
+}
+export interface IDrawPagePayload {
+    elementList: IElement[];
+    positionList: IElementPosition[];
+    rowList: IRow[];
+    pageNo: number;
+}
+export interface IPainterOption {
+    isDblclick: boolean;
+}
+export interface IGetValueOption {
+    pageNo?: number;
+    extraPickAttrs?: Array<keyof IElement>;
+}
+export type IGetOriginValueOption = Omit<IGetValueOption, 'extraPickAttrs'>;
+export interface IAppendElementListOption {
+    isPrepend?: boolean;
+    isSubmitHistory?: boolean;
+}
+export interface IGetImageOption {
+    pixelRatio?: number;
+    mode?: EditorMode;
+}
+export interface IComputeRowListPayload {
+    innerWidth: number;
+    elementList: IElement[];
+    startX?: number;
+    startY?: number;
+    isFromTable?: boolean;
+    isPagingMode?: boolean;
+    pageHeight?: number;
+    mainOuterHeight?: number;
+    surroundElementList?: IElement[];
+}

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

@@ -0,0 +1,143 @@
+import { EditorMode, PageMode, PaperDirection, RenderMode, WordBreak } from '../dataset/enum/Editor';
+import { IBackgroundOption } from './Background';
+import { ICheckboxOption } from './Checkbox';
+import { IRadioOption } from './Radio';
+import { IControlOption } from './Control';
+import { ICursorOption } from './Cursor';
+import { IFooter } from './Footer';
+import { IGroup } from './Group';
+import { IHeader } from './Header';
+import { ILabelOption } from './Label';
+import { IImgCaptionOption, IListOption } from './Element';
+import { ILineBreakOption } from './LineBreak';
+import { IMargin } from './Margin';
+import { IPageBreak } from './PageBreak';
+import { IPageNumber } from './PageNumber';
+import { IPlaceholder } from './Placeholder';
+import { ITitleOption } from './Title';
+import { IWatermark } from './Watermark';
+import { IZoneOption } from './Zone';
+import { ISeparatorOption } from './Separator';
+import { ITableOption } from './table/Table';
+import { ILineNumberOption } from './LineNumber';
+import { IPageBorderOption } from './PageBorder';
+import { IBadgeOption } from './Badge';
+import { IElement } from './Element';
+import { LocationPosition } from '../dataset/enum/Common';
+import { IRange } from './Range';
+import { IGraffitiData, IGraffitiOption } from './Graffiti';
+import { IWhiteSpaceOption } from './WhiteSpace';
+export interface IEditorData {
+    header?: IElement[];
+    main: IElement[];
+    footer?: IElement[];
+    graffiti?: IGraffitiData[];
+}
+export interface IEditorOption {
+    mode?: EditorMode;
+    locale?: string;
+    defaultType?: string;
+    defaultColor?: string;
+    defaultFont?: string;
+    defaultSize?: number;
+    minSize?: number;
+    maxSize?: number;
+    defaultBasicRowMarginHeight?: number;
+    defaultRowMargin?: number;
+    defaultTabWidth?: number;
+    width?: number;
+    height?: number;
+    scale?: number;
+    pageGap?: number;
+    underlineColor?: string;
+    strikeoutColor?: string;
+    rangeColor?: string;
+    rangeAlpha?: number;
+    rangeMinWidth?: number;
+    searchMatchColor?: string;
+    searchNavigateMatchColor?: string;
+    searchMatchAlpha?: number;
+    highlightAlpha?: number;
+    highlightMarginHeight?: number;
+    resizerColor?: string;
+    resizerSize?: number;
+    marginIndicatorSize?: number;
+    marginIndicatorColor?: string;
+    margins?: IMargin;
+    pageMode?: PageMode;
+    renderMode?: RenderMode;
+    defaultHyperlinkColor?: string;
+    paperDirection?: PaperDirection;
+    inactiveAlpha?: number;
+    historyMaxRecordCount?: number;
+    printPixelRatio?: number;
+    maskMargin?: IMargin;
+    letterClass?: string[];
+    contextMenuDisableKeys?: string[];
+    shortcutDisableKeys?: string[];
+    scrollContainerSelector?: string;
+    pageOuterSelectionDisable?: boolean;
+    wordBreak?: WordBreak;
+    table?: ITableOption;
+    header?: IHeader;
+    footer?: IFooter;
+    pageNumber?: IPageNumber;
+    watermark?: IWatermark;
+    control?: IControlOption;
+    checkbox?: ICheckboxOption;
+    radio?: IRadioOption;
+    cursor?: ICursorOption;
+    title?: ITitleOption;
+    placeholder?: IPlaceholder;
+    group?: IGroup;
+    pageBreak?: IPageBreak;
+    zone?: IZoneOption;
+    background?: IBackgroundOption;
+    lineBreak?: ILineBreakOption;
+    whiteSpace?: IWhiteSpaceOption;
+    separator?: ISeparatorOption;
+    lineNumber?: ILineNumberOption;
+    pageBorder?: IPageBorderOption;
+    badge?: IBadgeOption;
+    modeRule?: IModeRule;
+    graffiti?: IGraffitiOption;
+    label?: ILabelOption;
+    imgCaption?: IImgCaptionOption;
+    list?: IListOption;
+}
+export interface IEditorResult {
+    version: string;
+    data: IEditorData;
+    options: IEditorOption;
+}
+export interface IEditorHTML {
+    header: string;
+    main: string;
+    footer: string;
+}
+export type IEditorText = IEditorHTML;
+export type IUpdateOption = Omit<IEditorOption, 'mode' | 'width' | 'height' | 'scale' | 'pageGap' | 'pageMode' | 'paperDirection' | 'historyMaxRecordCount' | 'scrollContainerSelector'>;
+export interface ISetValueOption {
+    isSetCursor?: boolean;
+}
+export interface IFocusOption {
+    rowNo?: number;
+    range?: IRange;
+    position?: LocationPosition;
+    isMoveCursorToVisible?: boolean;
+}
+export interface IPrintModeRule {
+    imagePreviewerDisabled?: boolean;
+    backgroundDisabled?: boolean;
+}
+export interface IReadonlyModeRule {
+    imagePreviewerDisabled?: boolean;
+}
+export interface IFormModeRule {
+    controlDeletableDisabled?: boolean;
+}
+export interface IModeRule {
+    [EditorMode.PRINT]?: IPrintModeRule;
+    [EditorMode.READONLY]?: IReadonlyModeRule;
+    [EditorMode.FORM]?: IFormModeRule;
+}