@hatiolab/things-scene 3.0.0-beta.6 → 3.0.0

package/things-scene.d.ts

@@ -49,6 +49,17 @@ declare module '@hatiolab/things-scene' {
     help?: string
   }
 
+  type ReferenceProvider = {
+    get ids(): string[]
+    add(id: string, target?: any): Promise<Scene & { release: () => void }>
+    get(id: string, createIf?: boolean): Promise<Scene & { release: () => void }>
+  }
+
+  type DataSubscriptionProvider = {
+    subscribe(tag: string, component: Component): Promise<{ unsubscribe: () => void }>
+    dispose(): void
+  }
+
   interface LAYOUT {
     reflow: (container: Container) => void
     capturables?: (container: Container) => Component[]
@@ -102,6 +113,7 @@ declare module '@hatiolab/things-scene' {
     handlers,
     mode,
     refProvider,
+    dataSubscriptionProvider,
     baseUrl,
     fitMode
   }: {
@@ -111,7 +123,8 @@ declare module '@hatiolab/things-scene' {
     layers?: Array<any>
     handlers?: Array<any>
     mode?: SCENE_MODE
-    refProvider?: any
+    refProvider?: ReferenceProvider
+    dataSubscriptionProvider?: DataSubscriptionProvider
     baseUrl?: string | undefined
     fitMode?: FITMODE
   }): Scene
@@ -138,7 +151,8 @@ declare module '@hatiolab/things-scene' {
   }
 
   class ApplicationContext {
-    readonly refProvider: any
+    readonly refProvider: ReferenceProvider
+    readonly dataSubscriptionProvider: DataSubscriptionProvider
     readonly isViewMode: boolean
     readonly isEditMode: boolean
 
@@ -167,6 +181,7 @@ declare module '@hatiolab/things-scene' {
   ): {
     new (...args: any[]): {
       isDataSource(): boolean
+      _convertDataFormat(data: any, format: 'json' | 'text' | 'jsonp' | string): any
     }
   } & TBase
 
@@ -203,6 +218,12 @@ declare module '@hatiolab/things-scene' {
     static register(type: string, Clazz: typeof Component): void
     static memoize(base: any, property: string, needClone: boolean): void
     static drawStroke(context: CanvasRenderingContext2D, style: Style): void
+    static buildSubstitutor(
+      expression: string,
+      component: Component,
+      customObjToVal?: (obj: any) => any
+    ): () => string | undefined
+    static reposition(component: Component): void
 
     state: Properties
     bounds: BOUNDS
@@ -210,7 +231,7 @@ declare module '@hatiolab/things-scene' {
     root: RootContainer
     rootModel: ModelLayer
     parent: Container
-    app: ApplicationContext /* application context */
+    app: ApplicationContext
     model: Model
     hierarchy: Model
     path: Array<DIMENSION>
@@ -219,20 +240,27 @@ declare module '@hatiolab/things-scene' {
 
     get nature(): ComponentNature
 
+    get font(): string
+
     get data(): any
     set data(data: any)
 
+    get text(): string
+    set text(text: string)
+
     get center(): POINT
     set center(point: POINT)
 
     get controls(): Array<Control> | undefined
     get hasTextProperty(): boolean
+    get textSubstitutor(): () => string
 
     isRootModel(): boolean
     isContainer(): boolean
     isLine(): boolean
     isLayer(): boolean
     is3dish(): boolean
+    isHTMLElement(): boolean
 
     ready(): void
     dispose(): void
@@ -254,11 +282,16 @@ declare module '@hatiolab/things-scene' {
     executeMappings(force?: boolean): void
     invalidate(): void
     animate(config: AnimationConfig): {
-      start: Function /* start function */
-      stop: Function /* stop function */
+      start: Function
+      stop: Function
     }
 
+    access(expression: string): any
+    substitute(expression: string, customObjToVal?: (obj: any) => any): string
+
     onchange(after: Properties, before: Properties): void
+    onchangeData(after: Properties, before: Properties): void
+    onchangeMappings(after: Properties, before: Properties): void
 
     drawImage(
       context: CanvasRenderingContext2D,