@thienvu18/designable-core 2.0.1 → 2.0.2

package/lib/models/TreeNode.d.ts

@@ -1,115 +1,123 @@
-import { Operation } from './Operation';
-import { IDesignerProps, IDesignerLocales } from '../types';
+import { IDesignerLocales, IDesignerProps } from '../types'
+import { Operation } from './Operation'
 export interface ITreeNode {
-    componentName?: string;
-    sourceName?: string;
-    operation?: Operation;
-    hidden?: boolean;
-    isSourceNode?: boolean;
-    id?: string;
-    props?: Record<string | number | symbol, any>;
-    children?: ITreeNode[];
+  componentName?: string
+  sourceName?: string
+  operation?: Operation
+  hidden?: boolean
+  isSourceNode?: boolean
+  id?: string
+  props?: Record<string | number | symbol, any>
+  children?: ITreeNode[]
 }
 export interface INodeFinder {
-    (node: TreeNode): boolean;
+  (node: TreeNode): boolean
 }
 export declare class TreeNode {
-    parent: TreeNode;
-    root: TreeNode;
-    rootOperation: Operation;
-    id: string;
-    depth: number;
-    hidden: boolean;
-    componentName: string;
-    sourceName: string;
-    props: ITreeNode['props'];
-    children: TreeNode[];
-    isSelfSourceNode: boolean;
-    constructor(node?: ITreeNode, parent?: TreeNode);
-    makeObservable(): void;
-    get designerProps(): IDesignerProps;
-    get designerLocales(): IDesignerLocales;
-    get previous(): TreeNode;
-    get next(): TreeNode;
-    get siblings(): TreeNode[];
-    get index(): number;
-    get descendants(): TreeNode[];
-    get isRoot(): boolean;
-    get isInOperation(): boolean;
-    get lastChild(): TreeNode;
-    get firstChild(): TreeNode;
-    get isSourceNode(): boolean;
-    get operation(): Operation;
-    get viewport(): import("./Viewport").Viewport;
-    get outline(): import("./Viewport").Viewport;
-    get moveLayout(): "vertical" | "horizontal";
-    getElement(area?: 'viewport' | 'outline'): HTMLElement;
-    getValidElement(area?: 'viewport' | 'outline'): Element;
-    getElementRect(area?: 'viewport' | 'outline'): import("@thienvu18/designable-shared").Rect;
-    getValidElementRect(area?: 'viewport' | 'outline'): import("@thienvu18/designable-shared").Rect;
-    getElementOffsetRect(area?: 'viewport' | 'outline'): import("@thienvu18/designable-shared").Rect;
-    getValidElementOffsetRect(area?: 'viewport' | 'outline'): import("@thienvu18/designable-shared").Rect;
-    getPrevious(step?: number): TreeNode;
-    getAfter(step?: number): TreeNode;
-    getSibling(index?: number): TreeNode;
-    getParents(node?: TreeNode): TreeNode[];
-    getParentByDepth(depth?: number): any;
-    getMessage(token: string): any;
-    isMyAncestor(node: TreeNode): boolean;
-    isMyParent(node: TreeNode): boolean;
-    isMyParents(node: TreeNode): boolean;
-    isMyChild(node: TreeNode): boolean;
-    isMyChildren(node: TreeNode): boolean;
-    takeSnapshot(type?: string): void;
-    triggerMutation<T>(event: any, callback?: () => T, defaults?: T): T;
-    find(finder: INodeFinder): TreeNode;
-    findAll(finder: INodeFinder): TreeNode[];
-    distanceTo(node: TreeNode): number;
-    crossSiblings(node: TreeNode): TreeNode[];
-    allowSibling(nodes: TreeNode[]): boolean;
-    allowDrop(parent: TreeNode): boolean;
-    allowAppend(nodes: TreeNode[]): boolean;
-    allowClone(): boolean;
-    allowDrag(): boolean;
-    allowResize(): false | Array<'x' | 'y'>;
-    allowRotate(): void;
-    allowRound(): void;
-    allowScale(): void;
-    allowTranslate(): boolean;
-    allowDelete(): boolean;
-    findById(id: string): TreeNode;
-    contains(...nodes: TreeNode[]): boolean;
-    eachTree(callback?: (node: TreeNode) => void | boolean): void;
-    eachChildren(callback?: (node: TreeNode) => void | boolean): void;
-    resetNodesParent(nodes: TreeNode[], parent: TreeNode): TreeNode[];
-    setProps(props?: any): void;
-    setComponentName(componentName: string): void;
-    prepend(...nodes: TreeNode[]): TreeNode[];
-    append(...nodes: TreeNode[]): TreeNode[];
-    wrap(wrapper: TreeNode): TreeNode;
-    insertAfter(...nodes: TreeNode[]): TreeNode[];
-    insertBefore(...nodes: TreeNode[]): TreeNode[];
-    insertChildren(start: number, ...nodes: TreeNode[]): TreeNode[];
-    setChildren(...nodes: TreeNode[]): TreeNode[];
-    /**
-     * @deprecated
-     * please use `setChildren`
-     */
-    setNodeChildren(...nodes: TreeNode[]): TreeNode[];
-    remove(): void;
-    clone(parent?: TreeNode): TreeNode;
-    from(node?: ITreeNode): void;
-    serialize(): ITreeNode;
-    static create(node: ITreeNode, parent?: TreeNode): TreeNode;
-    static findById(id: string): TreeNode;
-    static remove(nodes?: TreeNode[]): void;
-    static sort(nodes?: TreeNode[]): TreeNode[];
-    static clone(nodes?: TreeNode[]): void;
-    static filterResizable(nodes?: TreeNode[]): TreeNode[];
-    static filterRotatable(nodes?: TreeNode[]): TreeNode[];
-    static filterScalable(nodes?: TreeNode[]): TreeNode[];
-    static filterRoundable(nodes?: TreeNode[]): TreeNode[];
-    static filterTranslatable(nodes?: TreeNode[]): TreeNode[];
-    static filterDraggable(nodes?: TreeNode[]): any[];
-    static filterDroppable(nodes: TreeNode[], parent: TreeNode): any[];
+  parent: TreeNode
+  root: TreeNode
+  rootOperation: Operation
+  id: string
+  depth: number
+  hidden: boolean
+  componentName: string
+  sourceName: string
+  props: ITreeNode['props']
+  children: TreeNode[]
+  isSelfSourceNode: boolean
+  constructor(node?: ITreeNode, parent?: TreeNode)
+  makeObservable(): void
+  get designerProps(): IDesignerProps
+  get designerLocales(): IDesignerLocales
+  get previous(): TreeNode
+  get next(): TreeNode
+  get siblings(): TreeNode[]
+  get index(): number
+  get descendants(): TreeNode[]
+  get isRoot(): boolean
+  get isInOperation(): boolean
+  get lastChild(): TreeNode
+  get firstChild(): TreeNode
+  get isSourceNode(): boolean
+  get operation(): Operation
+  get viewport(): import('./Viewport').Viewport
+  get outline(): import('./Viewport').Viewport
+  get moveLayout(): 'vertical' | 'horizontal'
+  getElement(area?: 'viewport' | 'outline'): HTMLElement
+  getValidElement(area?: 'viewport' | 'outline'): Element
+  getElementRect(
+    area?: 'viewport' | 'outline'
+  ): import('@thienvu18/designable-shared').Rect
+  getValidElementRect(
+    area?: 'viewport' | 'outline'
+  ): import('@thienvu18/designable-shared').Rect
+  getElementOffsetRect(
+    area?: 'viewport' | 'outline'
+  ): import('@thienvu18/designable-shared').Rect
+  getValidElementOffsetRect(
+    area?: 'viewport' | 'outline'
+  ): import('@thienvu18/designable-shared').Rect
+  getPrevious(step?: number): TreeNode
+  getAfter(step?: number): TreeNode
+  getSibling(index?: number): TreeNode
+  getParents(node?: TreeNode): TreeNode[]
+  getParentByDepth(depth?: number): any
+  getMessage(token: string): any
+  isMyAncestor(node: TreeNode): boolean
+  isMyParent(node: TreeNode): boolean
+  isMyParents(node: TreeNode): boolean
+  isMyChild(node: TreeNode): boolean
+  isMyChildren(node: TreeNode): boolean
+  takeSnapshot(type?: string): void
+  triggerMutation<T>(event: any, callback?: () => T, defaults?: T): T
+  find(finder: INodeFinder): TreeNode
+  findAll(finder: INodeFinder): TreeNode[]
+  distanceTo(node: TreeNode): number
+  crossSiblings(node: TreeNode): TreeNode[]
+  allowSibling(nodes: TreeNode[]): boolean
+  allowDrop(parent: TreeNode): boolean
+  allowAppend(nodes: TreeNode[]): boolean
+  allowClone(): boolean
+  allowDrag(): boolean
+  allowResize(): false | Array<'x' | 'y'>
+  allowRotate(): void
+  allowRound(): void
+  allowScale(): void
+  allowTranslate(): boolean
+  allowDelete(): boolean
+  findById(id: string): TreeNode
+  contains(...nodes: TreeNode[]): boolean
+  eachTree(callback?: (node: TreeNode) => void | boolean): void
+  eachChildren(callback?: (node: TreeNode) => void | boolean): void
+  resetNodesParent(nodes: TreeNode[], parent: TreeNode): TreeNode[]
+  setProps(props?: any): void
+  setComponentName(componentName: string): void
+  prepend(...nodes: TreeNode[]): TreeNode[]
+  append(...nodes: TreeNode[]): TreeNode[]
+  wrap(wrapper: TreeNode): TreeNode
+  insertAfter(...nodes: TreeNode[]): TreeNode[]
+  insertBefore(...nodes: TreeNode[]): TreeNode[]
+  insertChildren(start: number, ...nodes: TreeNode[]): TreeNode[]
+  setChildren(...nodes: TreeNode[]): TreeNode[]
+  /**
+   * @deprecated
+   * please use `setChildren`
+   */
+  setNodeChildren(...nodes: TreeNode[]): TreeNode[]
+  remove(): void
+  clone(parent?: TreeNode): TreeNode
+  from(node?: ITreeNode): void
+  serialize(): ITreeNode
+  static create(node: ITreeNode, parent?: TreeNode): TreeNode
+  static findById(id: string): TreeNode
+  static remove(nodes?: TreeNode[]): void
+  static sort(nodes?: TreeNode[]): TreeNode[]
+  static clone(nodes?: TreeNode[]): void
+  static filterResizable(nodes?: TreeNode[]): TreeNode[]
+  static filterRotatable(nodes?: TreeNode[]): TreeNode[]
+  static filterScalable(nodes?: TreeNode[]): TreeNode[]
+  static filterRoundable(nodes?: TreeNode[]): TreeNode[]
+  static filterTranslatable(nodes?: TreeNode[]): TreeNode[]
+  static filterDraggable(nodes?: TreeNode[]): any[]
+  static filterDroppable(nodes: TreeNode[], parent: TreeNode): any[]
 }