@sapui5/sap.fe.core 1.99.0 → 1.101.1

package/src/sap/fe/core/controllerextensions/PageReady.ts

@@ -1,18 +1,20 @@
+import Log from "sap/base/Log";
+import AppComponent from "sap/fe/core/AppComponent";
+import TemplatedViewServiceFactory from "sap/fe/core/services/TemplatedViewServiceFactory";
+import Event from "sap/ui/base/Event";
+import EventProvider from "sap/ui/base/EventProvider";
+import ManagedObject from "sap/ui/base/ManagedObject";
+import Component from "sap/ui/core/Component";
+import Core from "sap/ui/core/Core";
 import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
 import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
 import View from "sap/ui/core/mvc/View";
-import { ControllerExtensionMetadata } from "sap/fe/core/controllerextensions";
-import Component from "sap/ui/core/Component";
-import { AppComponent } from "sap/fe/core";
-import ManagedObject from "sap/ui/base/ManagedObject";
-import EventProvider from "sap/ui/base/EventProvider";
-import Log from "sap/base/Log";
 import Context from "sap/ui/model/Context";
-import { UI5Class, Override, Public, Final, Extensible, Private } from "../helpers/ClassSupport";
-import TemplatedViewServiceFactory from "sap/fe/core/services/TemplatedViewServiceFactory";
+import { CoreEx } from "types/extension_types";
 import CommonUtils from "../CommonUtils";
+import { defineUI5Class, extensible, finalExtension, methodOverride, privateExtension, publicExtension } from "../helpers/ClassSupport";
 
-@UI5Class("sap.fe.core.controllerextensions.PageReady", ControllerExtensionMetadata)
+@defineUI5Class("sap.fe.core.controllerextensions.PageReady")
 class PageReadyControllerExtension extends ControllerExtension {
 	private _oEventProvider!: EventProvider;
 	private _oView: any;
@@ -31,7 +33,7 @@ class PageReadyControllerExtension extends ControllerExtension {
 	private bTablesLoaded: boolean | undefined;
 	private pageReadyTimer: NodeJS.Timeout | undefined;
 
-	@Override()
+	@methodOverride()
 	public onInit() {
 		this._nbWaits = 0;
 		this._bSeachTriggered = false;
@@ -41,13 +43,14 @@ class PageReadyControllerExtension extends ControllerExtension {
 		this._oPageComponent = Component.getOwnerComponentFor(this._oView);
 
 		if (this._oPageComponent && this._oPageComponent.attachContainerDefined) {
-			this._oPageComponent.attachContainerDefined((oEvent: UI5Event) => this.registerContainer(oEvent.getParameter("container")));
+			this._oPageComponent.attachContainerDefined((oEvent: Event) => this.registerContainer(oEvent.getParameter("container")));
 		} else {
 			this.registerContainer(this._oView);
 		}
 
-		const oPlaceholder = ((this._oAppComponent.getRootControl() as View).getController() as any).getPlaceholder();
-		if (oPlaceholder.isPlaceholderDebugEnabled()) {
+		const oRootControlController = (this._oAppComponent.getRootControl() as View).getController() as any;
+		const oPlaceholder = oRootControlController.getPlaceholder && oRootControlController.getPlaceholder();
+		if (oPlaceholder?.isPlaceholderDebugEnabled()) {
 			this.attachEvent(
 				"pageReady",
 				null,
@@ -67,7 +70,7 @@ class PageReadyControllerExtension extends ControllerExtension {
 		}
 	}
 
-	@Override()
+	@methodOverride()
 	public onExit() {
 		// eslint-disable-next-line @typescript-eslint/ban-ts-comment
 		// @ts-ignore
@@ -75,8 +78,8 @@ class PageReadyControllerExtension extends ControllerExtension {
 		this._oContainer && this._oContainer.removeEventDelegate(this._fnContainerDelegate);
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public waitFor(oPromise: any) {
 		this._nbWaits++;
 		oPromise
@@ -87,16 +90,16 @@ class PageReadyControllerExtension extends ControllerExtension {
 			})
 			.catch(null);
 	}
-	@Override("_routing")
+	@methodOverride("_routing")
 	onRouteMatched() {
 		this._bIsPageReady = false;
 	}
-	@Override("_routing")
+	@methodOverride("_routing")
 	onRouteMatchedFinished() {
 		this.checkPageReadyDebounced();
 	}
 
-	@Override("_routing")
+	@methodOverride("_routing")
 	onAfterBinding(oBindingContext: Context) {
 		if (!this._bAfterBindingAlreadyApplied) {
 			this._bAfterBindingAlreadyApplied = true;
@@ -104,13 +107,13 @@ class PageReadyControllerExtension extends ControllerExtension {
 			const aNotBoundMDCTables: any[] = [];
 			let iRequested = 0;
 			let iReceived = 0;
-			const fnRequested = (oEvent: UI5Event) => {
-				oEvent.getSource().detachDataRequested(fnRequested);
+			const fnRequested = (oEvent: Event) => {
+				(oEvent.getSource() as any).detachDataRequested(fnRequested);
 				iRequested++;
 				this.bDataReceived = false;
 			};
-			const fnReceived = (oEvent: UI5Event) => {
-				switch (oEvent.getSource().sGroupId) {
+			const fnReceived = (oEvent: Event) => {
+				switch ((oEvent.getSource() as any).sGroupId) {
 					case "$auto.Workers":
 						this._oEventProvider.fireEvent("workersBatchReceived");
 						break;
@@ -119,7 +122,7 @@ class PageReadyControllerExtension extends ControllerExtension {
 						break;
 					default:
 				}
-				oEvent.getSource().detachDataReceived(fnReceived);
+				(oEvent.getSource() as any).detachDataReceived(fnReceived);
 				iReceived++;
 				if (iReceived >= iRequested && iRequested !== 0) {
 					iRequested = 0;
@@ -128,9 +131,9 @@ class PageReadyControllerExtension extends ControllerExtension {
 					this.checkPageReadyDebounced();
 				}
 			};
-			const fnSearch = (oEvent: UI5Event) => {
-				const aMDCTables = aNotBoundMDCTables.filter(oElem => {
-					if (oEvent.getSource().sId === oElem.getFilter() && oElem.getVisible()) {
+			const fnSearch = (oEvent: Event) => {
+				const aMDCTables = aNotBoundMDCTables.filter((oElem) => {
+					if ((oEvent.getSource() as any).sId === oElem.getFilter() && oElem.getVisible()) {
 						return true;
 					}
 					return false;
@@ -203,7 +206,7 @@ class PageReadyControllerExtension extends ControllerExtension {
 				} else {
 					const aBindingKeys = Object.keys(oElement.mBindingInfos);
 					if (aBindingKeys.length > 0) {
-						aBindingKeys.forEach(sPropertyName => {
+						aBindingKeys.forEach((sPropertyName) => {
 							const oListBinding = oElement.mBindingInfos[sPropertyName].binding;
 							// Register on all list binding, good for basic tables, problematic for MDC, see above
 							if (oListBinding && oListBinding.isA("sap.ui.model.odata.v4.ODataListBinding")) {
@@ -231,7 +234,7 @@ class PageReadyControllerExtension extends ControllerExtension {
 									aNotBoundMDCTables.push(oElement);
 								}
 							})
-							.catch(function(oError: Error) {
+							.catch(function (oError: Error) {
 								Log.error("Cannot find a bound table", oError as any);
 							})
 					);
@@ -246,7 +249,7 @@ class PageReadyControllerExtension extends ControllerExtension {
 						this.bTablesLoaded = true;
 						this.checkPageReadyDebounced();
 					})
-					.catch(oError => {
+					.catch((oError) => {
 						Log.info("There was an error with one or multiple table", oError);
 						this.bTablesLoaded = true;
 						this.checkPageReadyDebounced();
@@ -255,16 +258,16 @@ class PageReadyControllerExtension extends ControllerExtension {
 		}
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public isPageReady() {
 		return this._bIsPageReady;
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public waitPageReady(): Promise<void> {
-		return new Promise(resolve => {
+		return new Promise((resolve) => {
 			if (this.isPageReady()) {
 				resolve();
 			} else {
@@ -280,20 +283,20 @@ class PageReadyControllerExtension extends ControllerExtension {
 		});
 	}
 
-	@Public
-	@Final
-	public attachEventOnce(sEventId: string, oData: any, fnFunction: Function, oListener: any) {
+	@publicExtension()
+	@finalExtension()
+	public attachEventOnce(sEventId: string, oData: any, fnFunction?: Function, oListener?: any) {
 		// eslint-disable-next-line prefer-rest-params
-		return this._oEventProvider.attachEventOnce(sEventId, oData, fnFunction, oListener);
+		return this._oEventProvider.attachEventOnce(sEventId, oData, fnFunction as Function, oListener);
 	}
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public attachEvent(sEventId: string, oData: any, fnFunction: Function, oListener: any) {
 		// eslint-disable-next-line prefer-rest-params
 		return this._oEventProvider.attachEvent(sEventId, oData, fnFunction, oListener);
 	}
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	public detachEvent(sEventId: string, fnFunction: Function) {
 		// eslint-disable-next-line prefer-rest-params
 		return this._oEventProvider.detachEvent(sEventId, fnFunction);
@@ -317,12 +320,13 @@ class PageReadyControllerExtension extends ControllerExtension {
 		this._oContainer.addEventDelegate(this._fnContainerDelegate);
 	}
 
-	@Private
-	@Extensible(OverrideExecution.Instead)
+	@privateExtension()
+	@extensible(OverrideExecution.Instead)
 	public isContextExpected() {
 		return false;
 	}
 
+	@publicExtension()
 	public checkPageReadyDebounced() {
 		if (this.pageReadyTimer) {
 			clearTimeout(this.pageReadyTimer);
@@ -335,8 +339,8 @@ class PageReadyControllerExtension extends ControllerExtension {
 	public _checkPageReady(bFromNav: boolean = false) {
 		const fnUIUpdated = () => {
 			// Wait until the UI is no longer dirty
-			if (!sap.ui.getCore().getUIDirty()) {
-				sap.ui.getCore().detachEvent("UIUpdated", fnUIUpdated);
+			if (!Core.getUIDirty()) {
+				(Core as CoreEx).detachEvent("UIUpdated", fnUIUpdated);
 				this._bWaitingForRefresh = false;
 				setTimeout(() => {
 					this._checkPageReady();
@@ -346,11 +350,11 @@ class PageReadyControllerExtension extends ControllerExtension {
 
 		// In case UIUpdate does not get called, check if UI is not dirty and then call _checkPageReady
 		const checkUIUpdated = () => {
-			if (sap.ui.getCore().getUIDirty()) {
+			if (Core.getUIDirty()) {
 				setTimeout(checkUIUpdated, 500);
 			} else if (this._bWaitingForRefresh) {
 				this._bWaitingForRefresh = false;
-				sap.ui.getCore().detachEvent("UIUpdated", fnUIUpdated);
+				(Core as CoreEx).detachEvent("UIUpdated", fnUIUpdated);
 				this._checkPageReady();
 			}
 		};
@@ -361,20 +365,20 @@ class PageReadyControllerExtension extends ControllerExtension {
 			this.bTablesLoaded !== false &&
 			(!this.isContextExpected() || this.bHasContext) // Either no context is expected or there is one
 		) {
-			if (this.bDataReceived === true && !bFromNav && !this._bWaitingForRefresh && sap.ui.getCore().getUIDirty()) {
+			if (this.bDataReceived === true && !bFromNav && !this._bWaitingForRefresh && Core.getUIDirty()) {
 				// If we requested data we get notified as soon as the data arrived, so before the next rendering tick
 				this.bDataReceived = undefined;
 				this._bWaitingForRefresh = true;
-				sap.ui.getCore().attachEvent("UIUpdated", fnUIUpdated);
+				(Core as CoreEx).attachEvent("UIUpdated", fnUIUpdated);
 				setTimeout(checkUIUpdated, 500);
 			} else if (
-				(!this._bWaitingForRefresh && sap.ui.getCore().getUIDirty()) ||
+				(!this._bWaitingForRefresh && Core.getUIDirty()) ||
 				this._nbWaits !== 0 ||
 				TemplatedViewServiceFactory.getNumberOfViewsInCreationState() > 0 ||
 				this._bSeachTriggered
 			) {
 				this._bWaitingForRefresh = true;
-				sap.ui.getCore().attachEvent("UIUpdated", fnUIUpdated);
+				(Core as CoreEx).attachEvent("UIUpdated", fnUIUpdated);
 				setTimeout(checkUIUpdated, 500);
 			} else if (!this._bWaitingForRefresh) {
 				// In the case we're not waiting for any data (navigating back to a page we already have loaded)