@hatiolab/things-scene 2.7.19 → 2.7.23

package/things-scene.d.ts

@@ -1,11 +1,16 @@
 declare module '@hatiolab/things-scene' {
   type Constructor<T = {}> = new (...args: any[]) => T
+  type Class = { new (...args: any[]): any }
+  type Properties = { [key: string]: any }
 
-  type MODE_VIEW = 0
-  type MODE_EDIT = 1
-  type MODE_SHIFT = 2
+  const MODE_VIEW = 0
+  const MODE_EDIT = 1
+  const MODE_SHIFT = 2
 
-  type SCENE_MODE = MODE_VIEW | MODE_EDIT
+  enum SCENE_MODE {
+    VIEW = 0,
+    EDIT = 1
+  }
 
   type FITMODE = 'both' | 'ratio' | 'width' | 'height' | 'center' | 'none'
   type DIMENSION = { x: number; y: number }
@@ -13,7 +18,31 @@ declare module '@hatiolab/things-scene' {
   type TRANSLATE = DIMENSION
   type POSITION = DIMENSION
 
-  type Properties = { [key: string]: any }
+  type LAYOUT = {
+    reflow: (container: Container) => void
+    capturables?: (container: Container) => boolean
+    drawables?: (container: Container) => boolean
+    isStuck?: (component: Container) => boolean
+    keyNavigate?: (container: Container, component: Component, e: KeyboardEvent) => Component
+    joinType?: boolean
+  }
+
+  const AbsoluteLayout: LAYOUT & { ABSOLUTE: boolean }
+  const TableLayout: LAYOUT
+  const CardLayout: LAYOUT
+  const HTMLAbsoluteLayout: LAYOUT
+  const LinearHorizontal: LAYOUT
+  const LinearVertical: LAYOUT
+
+  type AnimationConfig = {
+    duration?: number
+    delay?: number
+    step: Function
+    delta: 'linear' | 'quad' | 'circ' | 'back' | 'bounce' | 'elastic' | Function
+    ease: 'out' | 'inout'
+    options?: object
+    repeat?: boolean
+  }
 
   type ControlHandler = {
     ondragstart?(point: POSITION, index: number, component: Component): void
@@ -62,7 +91,7 @@ declare module '@hatiolab/things-scene' {
   }
 
   class Model {
-    static compile(model: Model, context: any): Component
+    static compile(model: Model, context?: any): Component
 
     type: string;
     [key: string]: any
@@ -131,6 +160,7 @@ declare module '@hatiolab/things-scene' {
 
   class Component extends MixinEvent(Object) {
     static register(type: string, Clazz: typeof Component): void
+    static memoize(base: any, property: string, needClone: boolean): void
 
     state: Properties
     bounds: { top: number; left: number; width: number; height: number }
@@ -157,6 +187,11 @@ declare module '@hatiolab/things-scene' {
     transcoordP2S(x: number, y: number): POSITION
     render(context: CanvasRenderingContext2D): void
     executeMappings(force?: boolean): void
+    invalidate(): void
+    animate(config: AnimationConfig): {
+      start: Function /* start function */
+      stop: Function /* stop function */
+    }
 
     onchange(after: Properties, before: Properties): void
 
@@ -180,6 +215,11 @@ declare module '@hatiolab/things-scene' {
     indexOf(component: Component): number
     insertComponentAt(target: Component, idx: number): void
     findById(id: string): Component
+
+    add(components: Component[] | Component): Container
+    remove(components: Component[] | Component): Container
+
+    components: Component[]
   }
   class RootContainer extends Container {}
 
@@ -188,15 +228,17 @@ declare module '@hatiolab/things-scene' {
     canvas: HTMLCanvasElement
 
     getContext(): CanvasRenderingContext2D
-    invalidate(): void
   }
 
   class ModelLayer extends Layer {
     overlay: HTMLDivElement
   }
 
+  class Text extends RectPath(Component) {}
   class Shape extends Component {}
   class Ellipse extends Shape {}
+  class Polygon extends Shape {}
+  class Donut extends Ellipse {}
   class Rect extends RectPath(Shape) {}
   class HTMLOverlayElement extends MixinHTMLElement(RectPath(Component)) {}
 
@@ -231,23 +273,7 @@ declare module '@hatiolab/things-scene' {
      */
     remove(): void
 
-    animate({
-      duration /* unit: milli-second, 1000 milli-seconds by default */,
-      delay /* default 30 */,
-      step /* step function */,
-      delta /* delta function */,
-      ease /* ease function */,
-      options,
-      repeat /* default false */
-    }: {
-      duration: number
-      delay: number
-      step: Function
-      delta: 'linear' | 'quad' | 'circ' | 'back' | 'bounce' | 'elastic' | Function
-      ease: 'out' | 'inout'
-      options?: object
-      repeat: boolean
-    }): {
+    animate(config: AnimationConfig): {
       start: Function /* start function */
       stop: Function /* stop function */
     }