@hatiolab/things-scene 2.7.16 → 2.7.20

package/things-scene.d.ts

@@ -1,10 +1,13 @@
 declare module '@hatiolab/things-scene' {
   type Constructor<T = {}> = new (...args: any[]) => T
 
+  const MODE_VIEW = 0
+  const MODE_EDIT = 1
+  const MODE_SHIFT = 2
+
   enum SCENE_MODE {
-    MODE_VIEW = 0,
-    MODE_EDIT = 1,
-    MODE_SHIFT = 2
+    VIEW = 0,
+    EDIT = 1
   }
 
   type FITMODE = 'both' | 'ratio' | 'width' | 'height' | 'center' | 'none'
@@ -78,7 +81,10 @@ declare module '@hatiolab/things-scene' {
     dispose(): void
   }
 
+  /* mixins */
+
   function RectPath<TBase extends Constructor>(Base: TBase): TBase
+
   function ValueHolder<TBase extends Constructor>(
     Base: TBase
   ): {
@@ -88,6 +94,7 @@ declare module '@hatiolab/things-scene' {
       animOnValueChange(value: number, animFromBase: boolean, base: number): void
     }
   } & TBase
+
   function DataSource<TBase extends Constructor>(
     Base: TBase
   ): {
@@ -96,12 +103,42 @@ declare module '@hatiolab/things-scene' {
     }
   } & TBase
 
-  class Component {
+  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
@@ -109,6 +146,7 @@ declare module '@hatiolab/things-scene' {
     path: Array<DIMENSION>
     anchors: Array<Anchor>
     data: any
+
     get controls(): Array<Control> | undefined
     get hasTextProperty(): boolean
 
@@ -121,6 +159,7 @@ declare module '@hatiolab/things-scene' {
     reposition(): void
     transcoordP2S(x: number, y: number): POSITION
     render(context: CanvasRenderingContext2D): void
+    executeMappings(force?: boolean): void
 
     onchange(after: Properties, before: Properties): void
 
@@ -139,26 +178,37 @@ declare module '@hatiolab/things-scene' {
     ondblclick(e: MouseEvent): void
   }
 
-  class Container extends Component {
+  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 Component {
-    element: HTMLElement
-
-    createElement(): void
-  }
+  class HTMLOverlayElement extends MixinHTMLElement(RectPath(Component)) {}
 
   class HTMLOverlayContainer extends Container {
     readonly layout: any
   }
 
+  /* Scene API */
+
   class Scene {
     static readonly residents: WeakSet<Scene>
 
@@ -293,9 +343,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