@hatiolab/things-scene 2.7.14 → 2.7.18

package/things-scene.d.ts

@@ -1,13 +1,29 @@
 declare module '@hatiolab/things-scene' {
-  export const MODE_VIEW = 0
-  export const MODE_EDIT = 1
-  export const MODE_SHIFT = 2
+  type Constructor<T = {}> = new (...args: any[]) => T
+
+  const MODE_VIEW = 0
+  const MODE_EDIT = 1
+  const MODE_SHIFT = 2
 
   type FITMODE = 'both' | 'ratio' | 'width' | 'height' | 'center' | 'none'
-  type SCALE = { x: number; y: number }
-  type TRANSLATE = { x: number; y: number }
+  type DIMENSION = { x: number; y: number }
+  type SCALE = DIMENSION
+  type TRANSLATE = DIMENSION
+  type POSITION = DIMENSION
+
+  type Properties = { [key: string]: any }
+
+  type ControlHandler = {
+    ondragstart?(point: POSITION, index: number, component: Component): void
+    ondragmove?(point: POSITION, index: number, component: Component): void
+    ondragend?(point: POSITION, index: number, component: Component): void
+  }
 
-  export function create({
+  interface Control extends DIMENSION {
+    handler: ControlHandler
+  }
+
+  function create({
     target,
     model,
     style,
@@ -23,17 +39,173 @@ declare module '@hatiolab/things-scene' {
     style?: any
     layers?: Array<any>
     handlers?: Array<any>
-    mode?: 0 | 1
+    mode?: SCENE_MODE
     refProvider?: any
     baseUrl?: string | undefined
     fitMode?: FITMODE
   }): Scene
 
-  export class Component {}
-  export class Container {}
+  function error(...args: any[]): void
+  function warn(...args: any[]): void
+  function debug(...args: any[]): void
+
+  class ScriptLoader {
+    static load(scripts: string | Array<string>, styles?: string | Array<string>): Promise<void>
+  }
+
+  class Anchor {
+    constructor({ component, anchor, position }: { component: Component; anchor: string; position: POSITION })
+
+    position: POSITION
+  }
+
+  class Model {
+    static compile(model: Model, context: any): Component
+
+    type: string;
+    [key: string]: any
+  }
+
+  class ApplicationContext {
+    readonly refProvider: any
+    readonly isViewMode: boolean
+
+    mode: SCENE_MODE
+    baseUrl: string
+
+    dispose(): void
+  }
+
+  /* mixins */
+
+  function RectPath<TBase extends Constructor>(Base: TBase): TBase
+
+  function ValueHolder<TBase extends Constructor>(
+    Base: TBase
+  ): {
+    new (...args: any[]): {
+      value: number
+      animValue: number
+      animOnValueChange(value: number, animFromBase: boolean, base: number): void
+    }
+  } & TBase
+
+  function DataSource<TBase extends Constructor>(
+    Base: TBase
+  ): {
+    new (...args: any[]): {
+      isDataSource(): boolean
+    }
+  } & TBase
+
+  function MoveHandle<TBase extends Constructor>(Base: TBase): TBase
+
+  function MixinHTMLElement<TBase extends Constructor>(
+    Base: TBase
+  ): {
+    new (...args: any[]): {
+      get tagName(): string
+      element: HTMLElement
+
+      createElement(): void
+      userInputEventHandler(e: Event): void
+      reposition(): void
+      disposeElement(): void
+    }
+  } & TBase
+
+  function MixinEvent<TBase extends Constructor>(
+    Base: TBase
+  ): {
+    new (...args: any[]): {
+      on(name: string, callback: Function, context?: any): void
+      off(name: string, callback: Function, context?: any): void
+      once(name: string, callback: Function, context?: any): void
+      trigger(name: string): void
+    }
+  } & TBase
+
+  /* components */
+
+  class Component extends MixinEvent(Object) {
+    static register(type: string, Clazz: typeof Component): void
+
+    state: Properties
+    bounds: { top: number; left: number; width: number; height: number }
+    root: RootContainer
+    rootModel: ModelLayer
+    parent: Container
+    app: ApplicationContext /* application context */
+    model: Model
+    hierarchy: Model
+    path: Array<DIMENSION>
+    anchors: Array<Anchor>
+    data: any
+
+    get controls(): Array<Control> | undefined
+    get hasTextProperty(): boolean
+
+    ready(): void
+    dispose(): void
+    getState(prop: string): any
+    setState(props: Properties | any, value?: any): void
+    get(prop: string): any
+    set(props: Properties | string, value?: any): void
+    reposition(): void
+    transcoordP2S(x: number, y: number): POSITION
+    render(context: CanvasRenderingContext2D): void
+    executeMappings(force?: boolean): void
+
+    onchange(after: Properties, before: Properties): void
+
+    drawImage(
+      context: CanvasRenderingContext2D,
+      image: HTMLImageElement,
+      left: number,
+      top: number,
+      width: number,
+      height: number
+    ): void
+    drawStroke(context: CanvasRenderingContext2D): void
+    drawFill(context: CanvasRenderingContext2D): void
+    drawText(context: CanvasRenderingContext2D): void
+
+    ondblclick(e: MouseEvent): void
+  }
+
+  class ContainerAbstract extends MoveHandle(RectPath(Component)) {}
+  class Container extends MixinHTMLElement(ContainerAbstract) {
+    indexOf(component: Component): number
+    insertComponentAt(target: Component, idx: number): void
+    findById(id: string): Component
+  }
+  class RootContainer extends Container {}
+
+  class Layer extends ContainerAbstract {
+    target: HTMLElement
+    canvas: HTMLCanvasElement
+
+    getContext(): CanvasRenderingContext2D
+    invalidate(): void
+  }
+
+  class ModelLayer extends Layer {
+    overlay: HTMLDivElement
+  }
+
+  class Shape extends Component {}
+  class Ellipse extends Shape {}
+  class Rect extends RectPath(Shape) {}
+  class HTMLOverlayElement extends MixinHTMLElement(RectPath(Component)) {}
+
+  class HTMLOverlayContainer extends Container {
+    readonly layout: any
+  }
+
+  /* Scene API */
 
-  export class Scene {
-    static get residents(): WeakSet<Scene>
+  class Scene {
+    static readonly residents: WeakSet<Scene>
 
     /**
      * scene에 컴포넌트를 추가한다.
@@ -166,9 +338,9 @@ declare module '@hatiolab/things-scene' {
      */
     serialize(): string
 
-    on(event: string, listener: Function, context: any): void
-    once(event: string, listener: Function, context: any): void
-    off(event: string, listener: Function, context: any): void
+    on(event: string, listener: Function, context?: any): void
+    once(event: string, listener: Function, context?: any): void
+    off(event: string, listener: Function, context?: any): void
 
     toDataURL(): string