@leafer/interface 1.0.0-beta.9 → 1.0.0-rc.10

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "@leafer/interface",
-  "version": "1.0.0-beta.9",
+  "version": "1.0.0-rc.10",
   "description": "@leafer/interface",
   "author": "Chao (Leafer) Wan",
   "license": "MIT",
   "main": "src/index.ts",
+  "types": "types/index.d.ts",
   "files": [
-    "src"
+    "src",
+    "types",
+    "dist"
   ],
   "repository": {
     "type": "git",

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

@@ -1,39 +1,39 @@
-import { ILeaf } from '../display/ILeaf'
+import { ILeaf, ICursorType } from '../display/ILeaf'
 import { IRenderer, IRendererConfig } from '../renderer/IRenderer'
 import { IHitCanvas, ILeaferCanvas, ILeaferCanvasConfig, IHitCanvasConfig } from '../canvas/ILeaferCanvas'
 import { ILayouter, ILayouterConfig } from '../layouter/ILayouter'
 import { ISelector, ISelectorConfig } from '../selector/ISelector'
 import { IInteraction, IInteractionCanvas, IInteractionConfig } from '../interaction/IInteraction'
 import { IWatcher, IWatcherConfig } from '../watcher/IWatcher'
-import { IAutoBounds, IScreenSizeData } from '../math/IMath'
+import { IAutoBounds, IBoundsData, IPointData, IScreenSizeData } from '../math/IMath'
 import { ICanvasManager } from '../canvas/ICanvasManager'
 import { IHitCanvasManager } from '../canvas/IHitCanvasManager'
-import { IImageManager } from '../image/IImageManager'
 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'
 
 
-export type ILeaferType = 'draw' | 'design' | 'board' | 'document' | 'user'
+export type ILeaferType = 'draw' | 'design' | 'board' | 'document' | 'app' | 'game' | 'player' | 'chart'
 export interface ILeaferConfig extends IRendererConfig, ILeaferCanvasConfig, IInteractionConfig, ILayouterConfig {
     start?: boolean
     type?: ILeaferType
     realCanvas?: boolean
 }
 
-export interface ILeafer extends IZoomView, IControl {
-
-    readonly isApp: boolean
-    parent?: IApp
-
+export interface ILeaferAttrData {
     running: boolean
+    created: boolean
     ready: boolean
     viewReady: boolean
-    readonly viewLoaded: boolean
+    imageReady: boolean
+    viewCompleted: boolean
+    layoutLocked: boolean
+
+    transforming: boolean
 
     pixelRatio: number
 
@@ -50,29 +50,50 @@ export interface ILeafer extends IZoomView, IControl {
 
     canvasManager: ICanvasManager
     hitCanvasManager?: IHitCanvasManager
-    imageManager: IImageManager
 
     autoLayout?: IAutoBounds
 
     config: ILeaferConfig
 
+    readonly cursorPoint: IPointData
+    leafs: number
+
     __eventIds: IEventListenerId[]
+    __nextRenderWait: IFunction[]
+
+    init(userConfig?: ILeaferConfig, parentApp?: IAppBase): void
+
+    start(): void
+    stop(): void
 
-    init(userConfig?: ILeaferConfig, parentApp?: IApp): void
-    setZoomLayer(zoomLayer: ILeaf, moveLayer?: ILeaf): void
+    unlockLayout(): void
+    lockLayout(): void
+
+    setZoomLayer(zoomLayer: ILeaf): void
     forceFullRender(): void
+    forceRender(bounds?: IBoundsData): void
+    updateCursor(cursor?: ICursorType): void
     resize(size: IScreenSizeData): void
-    waitViewLoaded(fun: IFunction): void
+
+    waitReady(item: IFunction): void
+    waitViewReady(item: IFunction): void
+    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 {
@@ -83,6 +104,7 @@ export interface ICreator {
     image?(options?: ILeaferImageConfig): ILeaferImage
     canvas?(options?: ILeaferCanvasConfig, manager?: ICanvasManager): ILeaferCanvas
     hitCanvas?(options?: IHitCanvasConfig, manager?: ICanvasManager): IHitCanvas
+    hitCanvasManager?(): IHitCanvasManager
 
     watcher?(target: ILeaf, options?: IWatcherConfig): IWatcher
     layouter?(target: ILeaf, options?: ILayouterConfig): ILayouter
@@ -90,6 +112,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/ICanvas.ts

@@ -111,6 +111,8 @@ export interface CanvasPattern {
     setTransform(transform?: DOMMatrix2DInit): void
 }
 
+export type ICanvasPattern = CanvasPattern
+
 declare var CanvasPattern: {
     prototype: CanvasPattern
     new(): CanvasPattern

package/src/canvas/IHitCanvasManager.ts

@@ -6,5 +6,4 @@ import { IHitCanvas } from './ILeaferCanvas'
 export interface IHitCanvasManager extends ICanvasManager {
     getPathType(leaf: ILeaf): IHitCanvas
     getImageType(leaf: ILeaf, size: IScreenSizeData): IHitCanvas
-    destroy(): void
 }

package/src/canvas/ILeaferCanvas.ts

@@ -5,6 +5,8 @@ import { IResizeEventListener } from '../event/IEvent'
 import { IPathDrawer } from '../path/IPathDrawer'
 import { InnerId } from '../event/IEventer'
 import { ICanvasManager } from './ICanvasManager'
+import { IExportFileType } from '../file/IFileType'
+import { IExportOptions } from '../file/IExport'
 
 export interface ILeaferCanvasConfig extends IAutoBoundsData {
     view?: string | IObject
@@ -12,7 +14,6 @@ export interface ILeaferCanvasConfig extends IAutoBoundsData {
     pixelRatio?: number
     smooth?: boolean
     hittable?: boolean
-    offscreen?: boolean
     webgl?: boolean
 }
 
@@ -74,7 +75,7 @@ interface ICanvasMethod {
     strokeRect(x: number, y: number, width: number, height: number): void
     clearRect(x: number, y: number, width: number, height: number): void
 
-    transform(a: number, b: number, c: number, d: number, e: number, f: number): void
+    transform(a: number | IMatrixData, b?: number, c?: number, d?: number, e?: number, f?: number): void
     translate(x: number, y: number): void
     scale(x: number, y: number): void
     rotate(angle: number): void
@@ -110,12 +111,15 @@ interface ICanvasMethod {
     setStrokeOptions(options: ICanvasStrokeOptions): void
 
     setWorld(matrix: IMatrixData, parentMatrix?: IMatrixData): void
+    useWorldTransform(worldTransform?: IMatrixData): void
 
     setWorldShadow(x: number, y: number, blur: number, color?: string): void
     setWorldBlur(blur: number): void
 
     copyWorld(canvas: ILeaferCanvas, fromBounds?: IBoundsData, toBounds?: IBoundsData, blendMode?: string): void
+    copyWorldByReset(canvas: ILeaferCanvas, from?: IBoundsData, to?: IBoundsData, blendMode?: string, onlyResetTransform?: boolean): void
     copyWorldToInner(canvas: ILeaferCanvas, fromWorld: IMatrixWithBoundsData, toInnerBounds: IBoundsData, blendMode?: string): void
+
     useMask(maskCanvas: ILeaferCanvas, fromBounds?: IBoundsData, toBounds?: IBoundsData): void
     useEraser(eraserCanvas: ILeaferCanvas, fromBounds?: IBoundsData, toBounds?: IBoundsData): void
 
@@ -127,6 +131,7 @@ interface ICanvasMethod {
     clear(): void
 }
 
+export type ILeaferCanvasView = any
 export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     readonly innerId: InnerId
@@ -152,13 +157,11 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     autoLayout: boolean
 
-    view: any
+    view: ILeaferCanvasView
     parentView: any
 
     unreal?: boolean
 
-    offscreen: boolean
-
     context: ICanvasContext2D
 
     recycled?: boolean
@@ -167,8 +170,9 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     init(): void
 
+    export(filename: IExportFileType | string, options?: IExportOptions | number | boolean): string | Promise<any>
     toBlob(type?: string, quality?: number): Promise<IBlob>
-    toDataURL(type?: string, quality?: number): string
+    toDataURL(type?: string, quality?: number): string | Promise<string>
     saveAs(filename: string, quality?: number): Promise<boolean>
 
     startAutoLayout(autoBounds: IAutoBounds, listener: IResizeEventListener): void
@@ -180,10 +184,10 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     // other
     isSameSize(options: ILeaferCanvasConfig): boolean
-    getSameCanvas(useSameWorldTransform?: boolean): ILeaferCanvas
-    getBiggerCanvas(addWidth: number, addHeight: number): ILeaferCanvas
-    recycle(): void
+    getSameCanvas(useSameWorldTransform?: boolean, useSameSmooth?: boolean): ILeaferCanvas
+    recycle(clearBounds?: IBoundsData): void
 
+    updateRender(): void
     unrealCanvas(): void
     destroy(): 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
@@ -25,5 +24,4 @@ export interface IStringMap {
 
 export interface IDataTypeHandle {
     (target: any): void
-}
-
+}

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
@@ -9,19 +9,25 @@ export interface IDataProcessor extends IObject {
     __single: boolean
     __checkSingle(): void
 
-    __get(name: string): unknown
+    __get(name: string): any
+    __getData(): IObject
 
-    __setInput(name: string, value: unknown): void
-    __getInput(name: string): unknown
+    __setInput(name: string, value: any): void
+    __getInput(name: string): any
     __removeInput(name: string): void
     __getInputData(): IObject
 
-    __setMiddle(name: string, value: unknown): void
-    __getMiddle(name: string): unknown
+    __setMiddle(name: string, value: any): void
+    __getMiddle(name: string): any
 
     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/IBranch.ts

@@ -1,9 +1,11 @@
+import { ILeaf } from './ILeaf'
 import { ILeaferCanvas } from '../canvas/ILeaferCanvas'
 import { IRenderOptions } from '../renderer/IRenderer'
-import { ILeaf } from './ILeaf'
 
 export interface IBranch extends ILeaf {
     children: ILeaf[]
     __renderBranch?(canvas: ILeaferCanvas, options: IRenderOptions): void
-    removeAll(): void
+    addMany(...children: ILeaf[]): void
+    removeAll(destroy?: boolean): void
+    clear(): void
 }