Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
codeworrior opened this issue Jul 17, 2024 · 1 comment

Comments

@codeworrior
Copy link
Member

codeworrior commented Jul 17, 2024

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 SAP/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).

@akudev
Copy link
Contributor

akudev commented Jul 17, 2024

Related to #416, I think.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants