SAP / openui5

OpenUI5 lets you build enterprise-ready web applications, responsive to all devices, running on almost any browser of your choice.
http://openui5.org
Apache License 2.0
2.9k stars 1.23k forks source link

`sap.ui.qunit.utils.nextUIUpdate` and `waitForThemeApplied` recommended as replacements, but not exposed #4074

Open LukasHeimann opened 2 weeks ago

LukasHeimann commented 2 weeks ago

Prior to UI5 2.0, a couple of methods were deprecated. The jsdoc in OpenUI5, and thus TypeScript types as well as the UI5 linter expose the deprecation notices with hints to replace with alternatives from sap.ui.qunit.utils, i.e.

Indeed, those two methods are really useful when writing tests for custom controls. However, these methods are not exposed properly. nextUIUpdate is marked as @public, but waitForThemeApplied is not. Both are not shown on https://ui5.sap.com, and don't appear in the generated types, presumably due to deliberate exclusion at https://github.com/SAP/openui5/blob/4950f1d7fe76e02604ba165c47ce65c72f60b2b2/src/sap.ui.core/src/sap/ui/core/.library#L125

This discussion started at https://github.com/SAP/ui5-typescript/issues/459, but I was redirected here as the types are generated correctly, but the issue is the JSDoc and library configuration. Also, it was noted there that (until now) the two functions were deliberately not released (yet).

Thus, please consider properly exposing the two methods to end users, both in JSDoc as well as in TypeScript and https://ui5.sap.com.

Thank you very much for your support! Lukas

flovogt commented 1 week ago

Thanks a lot @LukasHeimann for reporting this issue. I have created an internal incident DINC0193814 and the respective team will update the status of the issue here in GitHub.