Skip to content

Type 'import("sap/ui/core/Popup").Dock' is not assignable to type 'typeof Dock' (since UI5 1.115.0) #466

Open
@codeworrior

Description

@codeworrior

Describe the bug
Since UI5 1.115.0, the TS types use a different strategy for enums attached to another API. They are no longer named exports, but attached as static properties.

When such an enum (e.g. Dock), exported as static property of a class (e.g. Popup.Dock), is used in the signature of yet another class (e.g. MessageToast), then the signature of that other class is broken. For a detailed example see UI5/openui5#4091.

Expected behavior
Any usage of such an enum in another API should work seamlessly.

Additional context
The problem is that the "usage in yet another class" currently uses the static property to refer to the type:

  import Popup from "sap/ui/core/Popup";

  interface MessageToast {
    show(
      msg: string,
      at: typeof Popup.Dock // <-- problem
    )
    ...

Unfortunately, this is not the same as the original enum. According to my experiments, it would be better to

  import type {Dock} from "sap/ui/core/Popup"; // ideally, import as type

  interface MessageToast {
    show(
      msg: string,
      at: Dock // <-- better declaration of type
    )
    ...

Interestingly, this works already today as the enum Dock is exported from Popup (any declaration in an ambient module declaration is implicitly an export, even without the keyword export).

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions