@leafer/interface 1.0.0-rc.5 → 1.0.0-rc.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leafer/interface",
-  "version": "1.0.0-rc.5",
+  "version": "1.0.0-rc.7",
   "description": "@leafer/interface",
   "author": "Chao (Leafer) Wan",
   "license": "MIT",

package/src/app/IApp.ts

@@ -1,6 +1,6 @@
-import { ILeafer } from './ILeafer'
+import { ILeaferBase } from './ILeafer'
 
-export interface IApp extends ILeafer {
-    children: ILeafer[]
+export interface IAppBase extends ILeaferBase {
+    children: ILeaferBase[]
     realCanvas: boolean
 }

package/src/app/ILeafer.ts

@@ -11,7 +11,7 @@ import { IHitCanvasManager } from '../canvas/IHitCanvasManager'
 import { IEventListenerId } from '../event/IEventer'
 import { IObject } from '../data/IData'
 import { IZoomView } from '../display/IView'
-import { IApp } from './IApp'
+import { IAppBase } from './IApp'
 import { ILeaferImage, ILeaferImageConfig } from '../image/ILeaferImage'
 import { IControl } from '../control/IControl'
 import { IFunction } from '../function/IFunction'
@@ -24,17 +24,13 @@ export interface ILeaferConfig extends IRendererConfig, ILeaferCanvasConfig, IIn
     realCanvas?: boolean
 }
 
-export interface ILeafer extends IZoomView, IControl {
-
-    readonly isApp: boolean
-    readonly app: ILeafer
-    parent?: IApp
-
+export interface ILeaferAttrData {
     running: boolean
     created: boolean
     ready: boolean
     viewReady: boolean
     viewCompleted: boolean
+    layoutLocked: boolean
 
     pixelRatio: number
 
@@ -62,7 +58,14 @@ export interface ILeafer extends IZoomView, IControl {
     __eventIds: IEventListenerId[]
     __nextRenderWait: IFunction[]
 
-    init(userConfig?: ILeaferConfig, parentApp?: IApp): void
+    init(userConfig?: ILeaferConfig, parentApp?: IAppBase): void
+
+    start(): void
+    stop(): void
+
+    unlockLayout(): void
+    lockLayout(): void
+
     setZoomLayer(zoomLayer: ILeaf): void
     forceFullRender(): void
     updateCursor(): void
@@ -73,14 +76,20 @@ export interface ILeafer extends IZoomView, IControl {
     waitViewCompleted(item: IFunction): void
 }
 
+export interface ILeaferBase extends IZoomView, IControl, ILeaferAttrData {
+    readonly isApp: boolean
+    readonly app: ILeaferBase
+    parent?: IAppBase
+}
+
 export interface ILeaferTypeCreator {
     list: ILeaferTypeList
     register(name: string, fn: ILeaferTypeFunction): void
-    run(name: string, leafer: ILeafer): void
+    run(name: string, leafer: ILeaferBase): void
 }
 
 export interface ILeaferTypeFunction {
-    (leafer: ILeafer): void
+    (leafer: ILeaferBase): void
 }
 
 export interface ILeaferTypeList {
@@ -98,6 +107,8 @@ export interface ICreator {
     selector?(target: ILeaf, options?: ISelectorConfig): ISelector
 
     interaction?(target: ILeaf, canvas: IInteractionCanvas, selector: ISelector, options?: IInteractionConfig): IInteraction
+
+    editor?(options?: IObject): ILeaf
 }
 
 export interface IUICreator {

package/src/canvas/ILeaferCanvas.ts

@@ -183,7 +183,7 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     // other
     isSameSize(options: ILeaferCanvasConfig): boolean
-    getSameCanvas(useSameWorldTransform?: boolean): ILeaferCanvas
+    getSameCanvas(useSameWorldTransform?: boolean, useSameSmooth?: boolean): ILeaferCanvas
     getBiggerCanvas(addWidth: number, addHeight: number): ILeaferCanvas
     recycle(): void
 

package/src/canvas/ISkiaCanvas.ts

@@ -1,7 +1,8 @@
 import { IExportFileType, IExportImageType } from '../file/IFileType'
 
-export type ICanvasType = 'skia' | 'canvas' | 'wx'
+export type ICanvasType = 'skia' | 'napi' | 'canvas' | 'wx'
 
+// skia
 export interface ISkiaCanvas {
     toBuffer(format: IExportFileType, config: ISkiaCanvasExportConfig): Promise<any>
     toBufferSync(format: IExportFileType, config: ISkiaCanvasExportConfig): any
@@ -17,4 +18,22 @@ export interface ISkiaCanvasExportConfig {
     density?: number,
     quality?: number,
     outline?: boolean
+}
+
+// skia-napi
+export interface ISkiaNAPICanvas {
+    encodeSync(format: 'webp' | 'jpeg', quality?: number): any
+    encodeSync(format: 'png'): any
+
+    encode(format: 'webp' | 'jpeg' | string, quality?: number): Promise<any>
+    encode(format: 'png'): Promise<any>
+
+    toBuffer(mime: 'image/png'): any
+    toBuffer(mime: 'image/jpeg' | 'image/webp' | string, quality?: number): any
+
+    toDataURL(mime?: 'image/png'): string
+    toDataURL(mime: 'image/jpeg' | 'image/webp' | string, quality?: number): string
+
+    toDataURLAsync(mime?: 'image/png'): Promise<string>
+    toDataURLAsync(mime: 'image/jpeg' | 'image/webp' | string, quality?: number): Promise<string>
 }

package/src/data/IData.ts

@@ -1,8 +1,7 @@
-export type __Number = number // number | string    will convert to number
-export type __Boolean = boolean // boolean | string  will convert to boolean
-export type __String = string //  string  | other   will convert to string
-export type __Object = IObject // will convert to object
-export type __Value = __Number | __Boolean | __String | __Object  // 
+export type INumber = number // number | string    will convert to number
+export type IBoolean = boolean // boolean | string  will convert to boolean
+export type IString = string //  string  | other   will convert to string
+export type IValue = INumber | IBoolean | IString | IObject  // 
 export type ITimer = any
 
 export type IPathString = string

package/src/data/ILeafData.ts

@@ -1,7 +1,7 @@
 import { ILeaf, ILeafComputedData } from '../display/ILeaf'
 import { IObject } from './IData'
 
-export interface IDataProcessor extends IObject {
+export interface IDataProcessor {
     __leaf: ILeaf
     __input: IObject
     __middle: IObject
@@ -10,6 +10,7 @@ export interface IDataProcessor extends IObject {
     __checkSingle(): void
 
     __get(name: string): any
+    __getData(): IObject
 
     __setInput(name: string, value: any): void
     __getInput(name: string): any
@@ -22,6 +23,11 @@ export interface IDataProcessor extends IObject {
     destroy(): void
 }
 
+export interface ILeafDataOptions {
+    attrs?: 'all' | string[]
+    children?: boolean
+}
+
 export interface ILeafData extends IDataProcessor, ILeafComputedData {
 
 }

package/src/data/IList.ts

@@ -18,13 +18,16 @@ export interface ILeafList {
     has(leaf: ILeaf): boolean
     indexAt(index: number): ILeaf
     indexOf(leaf: ILeaf): number
-    unshift(leaf: ILeaf): void
-    pushList(list: ILeaf[]): void
-    push(leaf: ILeaf): void
-    sort(reverse?: boolean): void
+
+    add(leaf: ILeaf): void
+    addAt(leaf: ILeaf, index: number): void
+    addList(list: ILeaf[]): void
     remove(leaf: ILeaf): void
+
     forEach(itemCallback: ILeafListItemCallback): void
+    sort(reverse?: boolean): void
     clone(): ILeafList
+    update(): void
     reset(): void
     destroy(): void
 }
@@ -37,8 +40,8 @@ export interface ILeafLevelList {
     has(leaf: ILeaf): boolean
     without(leaf: ILeaf): boolean
     sort(reverse?: boolean): void
-    pushList(list: ILeaf[]): void
-    push(leaf: ILeaf): void
+    addList(list: ILeaf[]): void
+    add(leaf: ILeaf): void
     forEach(itemCallback: ILeafListItemCallback): void
     reset(): void
     destroy(): void

package/src/display/ILeaf.ts

@@ -1,21 +1,22 @@
-import { ILeafer } from '../app/ILeafer'
+import { ILeaferBase } from '../app/ILeafer'
 import { IEventer } from '../event/IEventer'
 
 import { ILeaferCanvas, IHitCanvas } from '../canvas/ILeaferCanvas'
 import { IRenderOptions } from '../renderer/IRenderer'
 
-import { IObject, __Number, __Boolean, __Value, __String } from '../data/IData'
-import { IMatrixWithBoundsData, IMatrix, IPointData, IBoundsData, IRadiusPointData, IMatrixDecompositionAttr, IMatrixWithLayoutData } from '../math/IMath'
+import { IObject, INumber, IBoolean, IValue, IString } from '../data/IData'
+import { IMatrixWithBoundsData, IMatrix, IPointData, IBoundsData, IRadiusPointData, ILayoutAttr, IMatrixWithLayoutData, ILayoutBoundsData, IMatrixData } from '../math/IMath'
 import { IFunction } from '../function/IFunction'
 
 import { ILeafDataProxy } from './module/ILeafDataProxy'
 import { ILeafMatrix } from './module/ILeafMatrix'
 import { ILeafBounds } from './module/ILeafBounds'
-import { ILeafLayout, ILayoutBoundsType, ILayoutLocationType } from '../layout/ILeafLayout'
+import { ILeafLayout, IBoundsType, ILocationType } from '../layout/ILeafLayout'
 import { ILeafHit } from './module/ILeafHit'
 import { ILeafRender } from './module/ILeafRender'
 import { ILeafMask } from './module/ILeafMask'
 import { ILeafData } from '../data/ILeafData'
+import { IFindMethod } from '../selector/ISelector'
 
 
 export interface ICachedLeaf {
@@ -27,39 +28,44 @@ export interface ICachedLeaf {
 
 export interface ILeafAttrData {
     // layer data
-    id: __String
-    name: __String
-    className: __String
+    id: IString
+    name: IString
+    className: IString
 
     blendMode: IBlendMode
-    opacity: __Number
-    visible: __Boolean
-    isMask: __Boolean
-    isEraser: __Boolean
-    zIndex: __Number
+    opacity: INumber
+    visible: IBoolean
+    isMask: IBoolean
+    isEraser: IBoolean
+    locked: IBoolean
+    zIndex: INumber
 
     // layout data
-    x: __Number
-    y: __Number
-    width: __Number
-    height: __Number
-    scaleX: __Number
-    scaleY: __Number
-    rotation: __Number
-    skewX: __Number
-    skewY: __Number
-
-    scale: __Number | IPointData // helper
-    around: 'center' | IPointData
-
-    draggable: __Boolean
-
-    hittable: __Boolean
+    x: INumber
+    y: INumber
+    width: INumber
+    height: INumber
+    scaleX: INumber
+    scaleY: INumber
+    rotation: INumber
+    skewX: INumber
+    skewY: INumber
+
+    scale: INumber | IPointData // helper
+    around: IAround
+
+    draggable: IBoolean
+
+    editable: IBoolean
+    editSize?: IEditSize
+
+    hittable: IBoolean
     hitFill: IHitType
     hitStroke: IHitType
-    hitChildren: __Boolean
-    hitSelf: __Boolean
-    hitRadius: __Number
+    hitBox: IBoolean
+    hitChildren: IBoolean
+    hitSelf: IBoolean
+    hitRadius: INumber
 
     cursor: ICursorType | ICursorType[]
 }
@@ -98,14 +104,16 @@ export type IBlendMode =
     | 'destination-atop'
     | 'xor'
 
-export type IResizeType = 'size' | 'scale'
+export type IEditSize = 'size' | 'scale'
 export interface IImageCursor {
     url: string
     x?: number
     y?: number
 }
 
-export type IAround = 'center' | IPointData
+export type IAround =
+    | 'center'
+    | IPointData
 
 export type ICursorType =
     | IImageCursor
@@ -150,47 +158,55 @@ export type ICursorType =
 export interface ICursorTypeMap {
     [name: string]: ICursorType | ICursorType[]
 }
-export interface ILeafInputData extends IObject {
+export interface ILeafInputData {
     tag?: string
 
     // layer data
-    id?: __String
-    name?: __String
-    className?: __String
+    id?: IString
+    name?: IString
+    className?: IString
 
     blendMode?: IBlendMode
-    opacity?: __Number
-    visible?: __Boolean
-    isMask?: __Boolean
-    isEraser?: __Boolean
-    zIndex?: __Number
+    opacity?: INumber
+    visible?: IBoolean
+    isMask?: IBoolean
+    isEraser?: IBoolean
+    locked?: IBoolean
+    zIndex?: INumber
 
     // layout data
-    x?: __Number
-    y?: __Number
-    width?: __Number
-    height?: __Number
-    scaleX?: __Number
-    scaleY?: __Number
-    rotation?: __Number
-    skewX?: __Number
-    skewY?: __Number
-
-    scale?: __Number | IPointData // helper
+    x?: INumber
+    y?: INumber
+    width?: INumber
+    height?: INumber
+    scaleX?: INumber
+    scaleY?: INumber
+    rotation?: INumber
+    skewX?: INumber
+    skewY?: INumber
+
+    scale?: INumber | IPointData // helper
     around?: IAround
 
-    draggable?: __Boolean
+    draggable?: IBoolean
 
-    hittable?: __Boolean
+    editable?: IBoolean
+    editSize?: IEditSize
+
+    hittable?: IBoolean
     hitFill?: IHitType
     hitStroke?: IHitType
-    hitChildren?: __Boolean
-    hitSelf?: __Boolean
-    hitRadius?: __Number
+    hitBox?: IBoolean
+    hitChildren?: IBoolean
+    hitSelf?: IBoolean
+    hitRadius?: INumber
 
     cursor?: ICursorType | ICursorType[]
 
     children?: ILeafInputData[]
+
+    // other
+    noBounds?: boolean
 }
 export interface ILeafComputedData {
     // layer data
@@ -203,6 +219,7 @@ export interface ILeafComputedData {
     visible?: boolean
     isMask?: boolean
     isEraser?: boolean
+    locked?: boolean
     zIndex?: number
 
     // layout data
@@ -220,9 +237,13 @@ export interface ILeafComputedData {
 
     draggable?: boolean
 
+    editable?: boolean
+    editSize?: IEditSize
+
     hittable?: boolean
     hitFill?: IHitType
     hitStroke?: IHitType
+    hitBox?: boolean
     hitChildren?: boolean
     hitSelf?: boolean
     hitRadius?: number
@@ -244,7 +265,8 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     readonly __DataProcessor: IObject // IDataProcessor
     readonly __LayoutProcessor: IObject // ILeafLayout
 
-    leafer?: ILeafer
+    readonly app?: ILeaferBase
+    leafer?: ILeaferBase
     parent?: ILeaf
 
     readonly isApp?: boolean
@@ -253,10 +275,17 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     isBranchLeaf?: boolean
 
     __: ILeafData
+
+    proxyData?: ILeafInputData
+    __proxyData?: ILeafInputData
+
     __layout: ILeafLayout
 
     __world: IMatrixWithLayoutData
-    __local: IMatrixWithBoundsData
+    __local?: IMatrixWithBoundsData
+
+    readonly __localMatrix: IMatrixData
+    readonly __localBounds: IBoundsData
 
     __worldOpacity: number
 
@@ -273,10 +302,9 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     __level: number // 图层级别 root(1) -> hight
     __tempNumber?: number // 用于临时运算储存状态
 
-    readonly resizeable: boolean
-
-    readonly __hasMirror: boolean
+    readonly __worldFlipped: boolean
 
+    __hasAutoLayout?: boolean
     __hasMask?: boolean
     __hasEraser?: boolean
     __hitCanvas?: IHitCanvas
@@ -296,24 +324,34 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     waitLeafer(item: IFunction): void
     nextRender(item: IFunction): void
 
-    __bindLeafer(leafer: ILeafer | null): void
+    __bindLeafer(leafer: ILeaferBase | null): void
 
     set(data: IObject): void
+    get(): ILeafInputData
     toJSON(): IObject
     toString(): string
 
     // ILeafData ->
-    __setAttr(attrName: string, newValue: __Value): void
-    __getAttr(attrName: string): __Value
+    __setAttr(attrName: string, newValue: IValue): void
+    __getAttr(attrName: string): IValue
+    setProxyAttr(name: string, newValue: IValue): void
+    getProxyAttr(name: string): IValue
+
+    // find
+    find(condition: number | string | IFindMethod, options?: any): ILeaf[]
+    findOne(condition: number | string | IFindMethod, options?: any): ILeaf
 
     forceUpdate(attrName?: string): void
 
+    updateLayout(): void
+
     // ILeafMatrix ->
     __updateWorldMatrix(): void
     __updateLocalMatrix(): void
 
     // ILeafBounds ->
     __updateWorldBounds(): void
+    __updateLocalBounds(): void
 
     __updateLocalBoxBounds(): void
     __updateLocalStrokeBounds(): void
@@ -323,6 +361,7 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     __updateStrokeBounds(): void
     __updateRenderBounds(): void
 
+    __updateAutoLayout(): void
     __updateNaturalSize(): void
 
     __updateStrokeSpread(): number
@@ -333,12 +372,13 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     // IBranchMask ->
     __updateEraser(value?: boolean): void
     __updateMask(value?: boolean): void
-    __renderMask(canvas: ILeaferCanvas, content: ILeaferCanvas, mask: ILeaferCanvas): void
+    __renderMask(canvas: ILeaferCanvas, content: ILeaferCanvas, mask: ILeaferCanvas, recycle?: boolean): void
     __removeMask(child?: ILeaf): void
 
     // convert
-    getWorld(attrName: IMatrixDecompositionAttr): number
-    getBounds(type: ILayoutBoundsType, locationType?: ILayoutLocationType): IBoundsData
+    getWorld(attrName: ILayoutAttr): number
+    getBounds(type?: IBoundsType, relative?: ILocationType | ILeaf): IBoundsData
+    getLayoutBounds(type?: IBoundsType, relative?: ILocationType | ILeaf, unscale?: boolean): ILayoutBoundsData
 
     worldToLocal(world: IPointData, to?: IPointData, distance?: boolean, relative?: ILeaf): void
     localToWorld(local: IPointData, to?: IPointData, distance?: boolean, relative?: ILeaf): void
@@ -352,10 +392,17 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     getWorldPoint(inner: IPointData, relative?: ILeaf, distance?: boolean, change?: boolean): IPointData
     getWorldPointByLocal(local: IPointData, relative?: ILeaf, distance?: boolean, change?: boolean): IPointData
 
+    // transform
+    setTransform(transform?: IMatrixData, resize?: boolean): void
+    transform(transform?: IMatrixData, resize?: boolean): void
+
     move(x: number, y?: number): void
-    scaleOf(origin: IPointData, x: number, y?: number): void
+    scaleOf(origin: IPointData, scaleX: number, scaleY?: number, resize?: boolean): void
     rotateOf(origin: IPointData, rotation: number): void
-    skewOf(origin: IPointData, x: number, y: number): void
+    skewOf(origin: IPointData, skewX: number, skewY?: number, resize?: boolean): void
+
+    scaleResize(scaleX: number, scaleY: number, noResize?: boolean): void
+    __scaleResize(scaleX: number, scaleY: number): void
 
     // ILeafHit ->
     __hitWorld(point: IRadiusPointData): boolean
@@ -385,4 +432,5 @@ export interface ILeaf extends ILeafMask, ILeafRender, ILeafHit, ILeafBounds, IL
     __updateSortChildren(): void
     add(child: ILeaf, index?: number): void
     remove(child?: ILeaf, destroy?: boolean): void
+    dropTo(parent: ILeaf, index?: number, resize?: boolean): void
 }

package/src/display/module/ILeafBounds.ts

@@ -4,6 +4,7 @@ export type ILeafBoundsModule = ILeafBounds & ThisType<ILeaf>
 
 export interface ILeafBounds {
     __updateWorldBounds?(): void
+    __updateLocalBounds?(): void
 
     __updateLocalBoxBounds?(): void
     __updateLocalStrokeBounds?(): void
@@ -13,6 +14,7 @@ export interface ILeafBounds {
     __updateStrokeBounds?(): void
     __updateRenderBounds?(): void
 
+    __updateAutoLayout?(): void
     __updateNaturalSize?(): void
 
     __updateStrokeSpread?(): number

package/src/display/module/ILeafDataProxy.ts

@@ -1,10 +1,12 @@
 import { ILeaf } from '../ILeaf'
-import { __Value } from '../../data/IData'
+import { IValue } from '../../data/IData'
 
 export type ILeafDataProxyModule = ILeafDataProxy & ThisType<ILeaf>
 
 export interface ILeafDataProxy {
-    __setAttr?(name: string, newValue: __Value): void
-    __getAttr?(name: string): __Value
+    __setAttr?(name: string, newValue: IValue): void
+    __getAttr?(name: string): IValue
+    setProxyAttr?(name: string, newValue: IValue): void
+    getProxyAttr?(name: string): IValue
 }
 

package/src/display/module/ILeafMask.ts

@@ -6,7 +6,7 @@ export type ILeafMaskModule = ILeafMask & ThisType<ILeaf>
 export interface ILeafMask {
     __updateEraser?(value?: boolean): void
     __updateMask?(value?: boolean): void
-    __renderMask?(canvas: ILeaferCanvas, content: ILeaferCanvas, mask: ILeaferCanvas): void
+    __renderMask?(canvas: ILeaferCanvas, content: ILeaferCanvas, mask: ILeaferCanvas, recycle?: boolean): void
     __removeMask?(child?: ILeaf): void
 }
 

package/src/event/IEventer.ts

@@ -1,5 +1,9 @@
-import { IEvent, IFunction, IObject } from '@leafer/interface'
 import { ILeafEventer } from '../display/module/ILeafEventer'
+import { ILeaf } from '../display/ILeaf'
+import { IFunction } from '../function/IFunction'
+import { IEvent } from './IEvent'
+import { IObject } from '../data/IData'
+
 
 export type IEventListener = IFunction
 
@@ -18,6 +22,7 @@ export interface IEventListenerMap {
 
 export interface IEventListenerId {
     type: string | string[]
+    current: ILeaf
     listener: IEventListener
     options?: IEventListenerOptions | boolean
 }

package/src/function/IFunction.ts

@@ -10,4 +10,13 @@ export interface INumberFunction {
 
 export interface IPointDataFunction {
     (...arg: any): IPointData
+}
+
+
+export interface IAttrDecorator {
+    (...arg: any): IAttrDecoratorInner
+}
+
+interface IAttrDecoratorInner {
+    (target: any, key: string): any
 }