@hatiolab/things-scene 9.0.2 → 10.0.0-beta.2

package/things-scene.d.ts

@@ -1,799 +0,0 @@
-declare module '@hatiolab/things-scene' {
-  type Constructor<T = {}> = new (...args: any[]) => T
-  type Class = { new (...args: any[]): any }
-  type Properties = { [key: string]: any }
-  type State = Properties
-  type Style = Properties
-  type Decorator = (component: Component, context: CanvasRenderingContext2D, delta?: number) => boolean
-  type PopupOptions = {
-    data?: any
-    location?: 'center' | 'left-top' | 'right-top' | 'left-bottom' | 'right-bottom'
-    modal?: boolean
-    closable?: boolean
-    output?: boolean
-  }
-
-  type ChangeFunction = (selector: string, value: any, self: any) => Component[]
-
-  const MODE_VIEW = 0
-  const MODE_EDIT = 1
-  const MODE_SHIFT = 2
-  const MODE_ADD = 3
-  const MODE_PASTE_STYLE = 4
-  const MODE_PASTE_DATABIND = 5
-
-  enum SCENE_MODE {
-    VIEW = 0,
-    EDIT = 1,
-    SHIFT = 2,
-    ADD = 3,
-    PASTE_STYLE = 4,
-    PASTE_DATABIND = 5
-  }
-
-  type FITMODE = 'both' | 'ratio' | 'width' | 'height' | 'center' | 'none'
-  type POINT = { x: number; y: number; z?: number }
-  type SCALE = POINT
-  type TRANSLATE = POINT
-  type POSITION = POINT
-  type LOCATION = POINT
-  type ROTATION = POINT
-  type DIMENSION = { width: number; height: number; depth: number }
-  type BOUNDS = { left: number; top: number; width: number; height: number }
-  type DELTA = {
-    tx?: number
-    ty?: number
-    tz?: number
-    sx?: number
-    sy?: number
-    sz?: number
-    rx?: number
-    ry?: number
-    rz?: number
-    theta?: number
-  }
-
-  type ComponentNature = {
-    mutable?: boolean
-    resizable?: boolean
-    rotatable?: boolean
-    properties?: {
-      type: string
-      label: string
-      name: string
-      placeholder?: string
-      observe?: (this: HTMLElement, value: any) => void
-      readonly?: boolean
-      editor?: {
-        fullwidth?: boolean
-      }
-      property?:
-        | {
-            options?: any
-            [key: string]: any
-          }
-        | string
-    }[]
-    'value-property'?: string
-    valueProperty?: string
-    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 }>
-    create(id: string): 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[]
-    drawables?: (container: Container) => Component[]
-    isStuck?: (component: Container) => boolean
-    keyNavigate?: (container: Container, component: Component, e: KeyboardEvent) => Component | undefined
-    joinType?: boolean
-  }
-
-  interface LayoutRegistry {
-    register(name: string, layout: LAYOUT): void
-    unregister(name: string): void
-    get(name: string): LAYOUT
-    list(): { [name: string]: LAYOUT }
-  }
-
-  const Layout: LayoutRegistry
-
-  const AbsoluteLayout: LAYOUT & { ABSOLUTE: boolean }
-  const TableLayout: LAYOUT
-  const CardLayout: LAYOUT
-  const HTMLAbsoluteLayout: LAYOUT
-  const LinearHorizontalLayout: LAYOUT
-  const LinearVerticalLayout: LAYOUT
-
-  interface PersistentDataStorage {
-    load(key: object): Promise<any>
-    save(key: object, value: any): Promise<void>
-    clear(key: object): Promise<void>
-  }
-
-  type AnimationConfig = {
-    duration?: number
-    delay?: number
-    step: Function
-    delta: 'linear' | 'quad' | 'circ' | 'back' | 'bounce' | 'elastic' | Function
-    ease: 'in' | 'out' | 'inout'
-    options?: object
-    repeat?: boolean
-  }
-
-  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
-  }
-
-  interface Control extends POINT {
-    handler: ControlHandler
-    [key: string]: any
-  }
-
-  /**
-   * Things-Scene 컴포넌트를 등록하기 위한 데코레이터
-   *
-   * @param componentType 컴포넌트 타입 이름 또는 이름 배열
-   * @returns 클래스 데코레이터
-   *
-   * @example
-   * ```ts
-   * @sceneComponent('rect')
-   * export default class Rect extends RectPath(Shape) {
-   *   // 컴포넌트 구현
-   * }
-   * ```
-   *
-   * 여러 컴포넌트 타입을 한 번에 등록할 수도 있습니다:
-   * ```ts
-   * @sceneComponent(['input-text', 'input-password'])
-   * export default class Input extends HTMLOverlayElement {
-   *   // 컴포넌트 구현
-   * }
-   * ```
-   */
-  function sceneComponent(componentType: string | string[]): <T extends typeof Component>(target: T) => T
-
-  function create({
-    target,
-    model,
-    style,
-    layers,
-    handlers,
-    mode,
-    refProvider,
-    dataSubscriptionProvider,
-    dataStorage,
-    baseUrl,
-    fitMode
-  }: {
-    target?: HTMLElement
-    model: Object
-    style?: any
-    layers?: Array<any>
-    handlers?: Array<any>
-    mode?: SCENE_MODE
-    refProvider?: ReferenceProvider
-    dataSubscriptionProvider?: DataSubscriptionProvider
-    dataStorage?: PersistentDataStorage
-    baseUrl?: string | undefined
-    fitMode?: FITMODE
-  }): Scene
-
-  function error(...args: any[]): void
-  function warn(...args: any[]): void
-  function debug(...args: any[]): void
-
-  function FPS(): number
-
-  type EventHandler = (e: Event, ...args: any[]) => void
-
-  interface EventPropagation {
-    [delegator: string]: {
-      [target: string]: {
-        [event: string]: EventHandler
-      }
-    }
-  }
-
-  class EventMap {
-    static get(name: string): any
-    static register(name: string, EventMap: any): void
-    static unregister(name: string): void
-  }
-
-  class ReferenceMap<T> {
-    constructor(
-      creator: (boardId: string, resolve: (target: T) => void, reject: (error: any) => void) => Promise<T>,
-      disposer: (id: string, ref: T) => Promise<void>
-    )
-    get(id: string, createIf?: boolean): Promise<T & { release: () => void }>
-    get ids(): string[]
-    add(id: string, target: any): Promise<T & { release: () => void }>
-    create(id: string): Promise<T & { release: () => void }>
-  }
-
-  class ScriptLoader {
-    static load(scripts: string | Array<string>, styles?: string | Array<string>): Promise<void>
-  }
-  class ScenePopup {
-    static hideAll(root: Component): void
-    static hide(component: Component): void
-    static show(component: Component, ref: string, options: PopupOptions): void
-  }
-
-  type Anchor = {
-    name: string
-    position: POSITION
-    bounds?: BOUNDS
-    inout?: 'in' | 'out' | 'inout'
-    type?: string
-    multiplicity?: number
-    draw?: (this: Anchor, context: CanvasRenderingContext2D, component: Component) => void
-    filter?: (this: Anchor, linkEnd?: LinkEnd) => boolean
-    template?: any
-    [prop: string]: any
-  }
-
-  type LinkEndConfig = {
-    component: string /** end component refid */
-    anchor: string /** end anchor name of end component */
-    position: POSITION /** position of the link end */
-  }
-
-  class LinkEnd {
-    component: Component
-    anchor: Anchor
-    position: POSITION
-    fromto: 'from' | 'to'
-  }
-
-  class Model {
-    static compile(model: Model, context?: any): Component
-
-    type?: string;
-    [key: string]: any
-  }
-
-  class ApplicationContext {
-    readonly refProvider: ReferenceProvider
-    readonly dataStorage: PersistentDataStorage
-    readonly dataSubscriptionProvider: DataSubscriptionProvider
-    readonly isViewMode: boolean
-    readonly isEditMode: boolean
-
-    mode: SCENE_MODE
-    baseUrl: string
-
-    url(x: string): 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
-      _convertDataFormat(data: any, format: 'json' | 'text' | 'jsonp' | string): any
-    }
-  } & TBase
-
-  function MoveHandle<TBase extends Constructor>(Base: TBase): TBase
-
-  function Connectable<TBase extends Constructor>(
-    Base: TBase
-  ): {
-    new (...args: any[]): {
-      findOutletLines(anchorName: string): Line[]
-      findOutletEnds(anchorName: string): Component[]
-      findInletLines(anchorName: string): Line[]
-      findInletEnds(anchorName: string): Component[]
-    }
-  } & 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, ...others: any[]): void
-    }
-  } & TBase
-
-  /* components */
-
-  class Component extends MixinEvent(Object) {
-    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
-    static registerDecorator(name: string, decorator: Decorator): void
-    static createCanvas(width: number, height: number): HTMLCanvasElement
-    static template(
-      template: string,
-      options?: {
-        escape?: RegExp
-        evaluate?: RegExp
-        imports?: any
-        interpolate?: RegExp
-        sourceURL?: string
-        variable?: string
-      }
-    ): any
-
-    state: Properties
-    root: RootContainer
-    rootModel: ModelLayer
-    parent: ContainerAbstract
-    app: ApplicationContext
-
-    get nature(): ComponentNature
-
-    get bounds(): BOUNDS
-    set bounds(bounds: BOUNDS)
-
-    get model(): Model
-    get hierarchy(): Model
-
-    get disposed(): boolean
-    get font(): string
-
-    get data(): any
-    set data(data: any)
-
-    get hidden(): boolean
-    set hidden(hidden: boolean)
-
-    get value(): any
-    set value(value: any)
-
-    get text(): string
-    set text(text: string)
-
-    get textBounds(): BOUNDS
-    get textRotation(): number
-
-    get path(): Array<POINT>
-    set path(path: Array<POINT>)
-
-    get center(): POINT
-    set center(point: POINT)
-
-    get location(): POINT
-    set location(location: POINT)
-
-    get rotate(): ROTATION
-    set rotate(rotation: ROTATION)
-
-    get dimension(): DIMENSION
-    set dimension(dimension: DIMENSION)
-
-    get strokeStyle(): any
-    set strokeStyle(strokeStyle: any)
-
-    get fillStyle(): any
-    set fillStyle(fillStyle: any)
-
-    get anchors(): Array<Anchor>
-    get controls(): Array<Control> | undefined
-    get hasTextProperty(): boolean
-    get textSubstitutor(): () => string
-
-    get decorators(): Array<string | Decorator>
-    get reactionDecorators(): Array<string | Decorator>
-
-    get started(): boolean
-    set started(started: boolean)
-
-    get tag(): string
-    set tag(tag: string)
-
-    get appendum(): any
-    set appendum(appendum: any)
-
-    get position(): string
-
-    resetAnimation(): void
-
-    isRootModel(): boolean
-    isContainer(): boolean
-    isLine(): boolean
-    isLayer(): boolean
-    is3dish(): boolean
-    isHTMLElement(): boolean
-    isConnectable(): boolean
-    isIdentifiable(): boolean
-    isTemplate(): boolean
-    isIn3DSpace(): boolean
-    isPositionable(): boolean
-
-    ready(): void
-    dispose(): void
-    getState(prop: string): any
-    setState(props: Properties | any, value?: any): void
-    get(prop: string): any
-    contains(x: number, y: number): boolean
-    set(props: Properties | string, value?: any): void
-    reposition(): void
-    clearCache(): void
-
-    /*
-     * selector에 해당하는 모든 컴포넌트들을 찾는다.
-     * @params selector {string}
-     */
-    findAll(selector: string, component?: Component): Array<Component>
-
-    /*
-     * selector에 해당하는 첫번째 컴포넌트를 찾는다.
-     * @params selector {string}
-     */
-    findFirst(selector: string, ...others: any[]): Component
-
-    prepareIf(condition: boolean): void
-    mutatePath(
-      beforeLogic: ((path: Array<POINT>) => void) | null,
-      afterLogic: ((path: Array<POINT>) => void) | null,
-      context?: any
-    ): void
-
-    transcoordP2S(x: number, y: number): POSITION
-    transcoordC2S(x: number, y: number, top?: RootContainer): POSITION
-    transcoordS2T(x: number, y: number): POSITION
-    transcoordS2C(x: number, y: number, top?: RootContainer): POSITION
-
-    prerender(context: CanvasRenderingContext2D): void
-    render(context: CanvasRenderingContext2D): void
-    postrender(context: CanvasRenderingContext2D): void
-
-    executeMappings(force?: boolean): void
-    invalidate(): void
-    animate(config: AnimationConfig): {
-      start: Function
-      stop: Function
-    }
-    delta(attr?: string, value?: number): DELTA | void
-
-    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,
-      image: HTMLImageElement,
-      left: number,
-      top: number,
-      width: number,
-      height: number
-    ): void
-    drawStroke(context: CanvasRenderingContext2D, override?: { [prop: string]: any }): void
-    drawFill(context: CanvasRenderingContext2D, override?: { [prop: string]: any }): void
-    drawText(context: CanvasRenderingContext2D): void
-    move(position: { x: number; y: number }, absolutely?: boolean): void
-
-    ondblclick(e: MouseEvent): void
-
-    closeScene(data: any): void
-  }
-
-  class ContainerAbstract extends MoveHandle(RectPath(Component)) {
-    indexOf(component: Component): number
-    size(): number
-    addComponent(target: Component, ghost?: boolean): void
-    removeComponent(target: Component, ghost?: boolean): void
-    insertComponentAt(target: Component, idx: number, ghost?: boolean): void
-    findById(id: string): Component | undefined
-    findAllById(id: string): Component[]
-    getAt(at: number): Component | undefined
-
-    reflow(): void
-
-    add(components: Component[] | Component, ghost?: boolean): Container
-    remove(components: Component[] | Component, ghost?: boolean): Container
-
-    components: Component[]
-  }
-  class Container extends MixinHTMLElement(ContainerAbstract) {}
-  class RootContainer extends Container {
-    get selected(): Component[]
-    set selected(selected: Component[])
-    get style(): { [key: string]: any }
-  }
-
-  class Layer extends ContainerAbstract {
-    target: HTMLElement | null
-    canvas: HTMLCanvasElement | null
-
-    getContext(component?: Component): CanvasRenderingContext2D
-    getOverlay(component?: Component): HTMLElement
-
-    centerTo(component: Component, animated?: boolean): void
-  }
-
-  class ModelLayer extends Layer {
-    overlay: HTMLDivElement
-  }
-
-  class InfoWindow extends RectPath(Shape) {}
-  class Text extends RectPath(Component) {}
-  class Shape extends Component {}
-  class Ellipse extends Shape {}
-  class Polygon extends Shape {}
-  class Popup extends RectPath(Shape) {}
-  class Line extends Component {
-    get fromEnd(): LinkEnd | undefined
-    get toEnd(): LinkEnd | undefined
-    get from(): LinkEndConfig
-    get to(): LinkEndConfig
-  }
-  class OrthoLine extends Line {}
-  class Donut extends Ellipse {}
-  class Rect extends RectPath(Shape) {}
-  class HTMLOverlayElement extends MixinHTMLElement(RectPath(Component)) {}
-
-  class HTMLOverlayContainer extends Container {
-    readonly layout: any
-  }
-
-  /* Scene API */
-
-  class Scene {
-    static readonly residents: WeakSet<Scene>
-    static readonly DPPX: number
-
-    /**
-     * scene에 컴포넌트를 추가한다.
-     * @param models {object} - Component Model Object
-     * @param boundsOrOffset {object} - x, y, cx, cy, ...
-     * @param onto {string} - onto
-     */
-    add(
-      models: Model,
-      boundsOrOffset?: {
-        left?: number
-        top?: number
-        width?: number
-        height?: number
-        x?: number
-        y?: number
-        cx?: number
-        cy?: number
-      },
-      onto?: string
-    ): Component
-
-    /**
-     * scene에 컴포넌트를 추가하는 모드를 시작한다.
-     * @param models {object} - Component Model Object
-     */
-    startAddMode(models: Model): void
-
-    /**
-     * scene의 컴포넌트를 복제한다.
-     * 현재 선택되어있는 컴포넌트가 복제되므로, 컴포넌트를 복제하기 위해서는
-     * 먼저 복제하고자하는 컴포넌트를 선택된 상태로 만든 후에(참조. {@link select} 메쏘드) 이 메쏘드를 호출한다.
-     */
-    duplicate(): void
-
-    /**
-     * scene의 컴포넌트를 삭제한다.
-     * 현재 선택되어있는 컴포넌트가 삭제되므로, 컴포넌트를 삭제하기 위해서는
-     * 먼저 삭제하고자하는 컴포넌트를 선택된 상태로 만든 후에(참조. {@link select} 메쏘드) 이 메쏘드를 호출한다.
-     */
-    remove(): void
-
-    animate(config: AnimationConfig): {
-      start: Function /* start function */
-      stop: Function /* stop function */
-    }
-
-    /**
-     * scene이 그려지고 있는 컨테이너를 전체화면 모드에서 표시되도록 한다.
-     */
-    fullscreen(): void
-
-    /**
-     * 파라미터로 주어지는 id를 가진 컴포넌트의 data 값을 변경한다.
-     * @param id {string} - component id
-     * @param value {any} - data value
-     */
-    variable(id: string, value: any): any
-
-    target: HTMLElement | null
-    scale: SCALE
-    translate: TRANSLATE
-
-    readonly unit: string /* 'px' */
-    readonly PPM: number
-    readonly PPI: number
-    readonly DPPX: number
-
-    mode: SCENE_MODE
-
-    /**
-     * Scene 모델의 단위(unit)을 감안한 기본 Scale 값을 제공한다.
-     * 통산 'mm', 'cm' 단위의 Scene은 각 값에 10배를 곱한 수치로 모델링된다.(값을 10으로 나눈값이 실제 단위와 일치한다.)
-     * unitScale의 의미는 scene에 unitScale값으로 scale하면, 각 단위값이 화면과 일치한다는 의미이다.
-     *
-     * 모델링의 수치단위가 픽셀이 아니고, mm, cm, inch 등의 단위인 경우에,
-     * 화면에서의 크기가 실물과 유사하게 보이는 수준의 기본 스케일을 제공하는 기능이다.
-     * 이 값은 내부적으로는, Ruler에서 눈금을 실제 자의 눈금과 일치시키기 위해서 사용한다.
-     */
-    readonly unitScale: string
-
-    /**
-     * scene이 그려질 모니터 화면의 크기정보 (inch)
-     * 예시) 17, 20, 24, 27, 30, ...
-     * @type {number}
-     */
-    screen: number
-
-    /**
-     * 컨테이너의 크기에 맞게 크기를 조정한다.
-     */
-    resize(): void
-
-    release(): void
-    dispose(): void
-
-    /* Selection Based API - Modeling APIs */
-
-    /**
-     * scene 내에서 선택된 컴포넌트의 리스트
-     * @type {object-array}
-     */
-    selected: Array<Component>
-
-    /**
-     * scene이 그리고 있는 컴포넌트 모델정보
-     * @type {object}
-     */
-    model: Model
-
-    /*
-     * root는 모델의 최상위 컨테이너인 모델레이어를 의미한다.
-     */
-    readonly root: Container
-
-    /*
-     * rootContainer는 모든 컴포넌트의 최상위 컨테이너이다.
-     * 이 컨테이너는 하위에 모델레이어를 위주로 많은 자식 컴포넌트를 보유한다.
-     */
-    readonly rootContainer: RootContainer
-
-    /*
-     * selector에 해당하는 모든 컴포넌트들을 찾는다.
-     * @params selector {string}
-     */
-    findAll(selector: string, component?: Component): Array<Component>
-
-    /*
-     * selector에 해당하는 첫번째 컴포넌트를 찾는다.
-     * @params selector {string}
-     */
-    findFirst(selector: string, ...others: any[]): Component
-
-    /*
-     * id를 갖는 컴포넌트를 찾는다.
-     * @params id {string}
-     */
-    findById(id: string): Component
-
-    /*
-     * id를 갖는 모든 컴포넌트를 찾는다.
-     * @params id {string}
-     */
-    findAllById(id: string): Component[]
-
-    /*
-     * scene이 그리는 모델 오브젝트를 JSON 텍스트로 리턴한다.
-     */
-    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
-
-    toDataURL(): string
-
-    fit(type?: FITMODE): void
-
-    readonly fitMode: FITMODE
-    readonly ids: { [id: string]: any }[]
-
-    copy(): string
-    cut(): string
-    redo(): void
-    undo(): void
-    preserve(): void
-    undoable(): boolean
-    redoable(): boolean
-    hasUnpreservedChanges(): boolean
-    move(component: Component, to_container: Container, to_index: number): void
-    centerTo(component: Component, animated?: boolean): void
-
-    select(selector: string | Function, ...others: (string | Function)[]): Component[]
-    paste(clipboard: string): void
-    align(type: 'left' | 'right' | 'center' | 'top' | 'bottom' | 'middle' | string): void
-    place(type: 'left' | 'right' | 'center' | 'top' | 'bottom' | 'middle' | string): void
-    distribute(type: string): void
-    symmetryX(): void
-    symmetryY(): void
-
-    group(): void
-    ungroup(): void
-
-    change(f: ChangeFunction): void
-    undoableChange(f: () => void): void
-    zorder(type: 'forward' | 'backward' | 'front' | string): void
-
-    startStylePasteMode(): void
-    stopStylePasteMode(): void
-
-    startDatabindPasteMode(): void
-    stopDatabindPasteMode(): void
-
-    data: object
-    dataByRefid: object
-
-    values: object
-    valuesByRefid: object
-
-    anchorStarterTemplate: object
-
-    // @deprecated
-    variables: object
-
-    baseUrl: string
-  }
-}