@sapui5/sap.ushell 1.138.1 → 1.140.0

package/src/main/js/sap/ushell/appIntegration/PostMessageHandler/AppInfoHandler.js

@@ -0,0 +1,225 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+/**
+ * @file This file contains the AppInfoHandler class.
+ *
+ * Any handlers that are relevant for applications
+ * - ShellUIService (setTitle, setBackNavigation, ...)
+ * - ApplicationWidth
+ * - AppInfo (AboutDialog)
+ * - DirtyState Handling
+ */
+sap.ui.define([
+    "sap/base/util/Deferred",
+    "sap/ushell/appIntegration/PostMessageManager",
+    "sap/ushell/Container",
+    "sap/ushell/utils"
+], (
+    Deferred,
+    PostMessageManager,
+    Container,
+    ushellUtils
+) => {
+    "use strict";
+
+    const oDistributionPolicies = {};
+
+    const oServiceRequestHandlers = {
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.ui5service.ShellUIService.setBackNavigation": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                let fnCallback;
+                if (oMessageBody.callbackMessage?.service) {
+                    oApplicationContainer.addCapabilities([
+                        oMessageBody.callbackMessage.service
+                    ]);
+
+                    fnCallback = () => {
+                        oApplicationContainer.sendRequest(
+                            oMessageBody.callbackMessage.service,
+                            null, // oMessageBody
+                            false // bWaitForResponse
+                        );
+                    };
+                } // empty body or callback message will call the setBackNavigation with undefined, this should reset the back button callback
+
+                ShellUIService.setBackNavigation(fnCallback);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.ui5service.ShellUIService.setTitle": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { sTitle, oAdditionalInformation } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setTitle(sTitle, oAdditionalInformation);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setTitle": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { sTitle, oAdditionalInformation } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setTitle(sTitle, oAdditionalInformation);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setHierarchy": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { aHierarchyLevels } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setHierarchy(aHierarchyLevels);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setRelatedApps": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { aRelatedApps } = oMessageBody;
+                const ShellUIService = oApplicationContainer.getShellUIService();
+
+                ShellUIService.setRelatedApps(aRelatedApps);
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.AppLifeCycle.setNewAppInfo": {
+            async handler (oMessageBody, oMessageEvent) {
+                const oParams = oMessageBody;
+                const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+
+                AppLifeCycle.setAppInfo(oParams, true);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppLifeCycle.updateCurrentAppInfo": {
+            async handler (oMessageBody, oMessageEvent) {
+                const oParams = oMessageBody;
+                const AppLifeCycle = await Container.getServiceAsync("AppLifeCycle");
+
+                AppLifeCycle.setAppInfo(oParams, false);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppConfiguration.setApplicationFullWidth": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { bValue } = oMessageBody;
+
+                const [AppConfiguration] = await ushellUtils.requireAsync(["sap/ushell/services/AppConfiguration"]);
+
+                AppConfiguration.setApplicationFullWidthInternal(bValue);
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.ShellUIService.setDirtyFlag": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { bIsDirty } = oMessageBody;
+
+                Container.setDirtyFlag(bIsDirty);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.Container.setDirtyFlag": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { bIsDirty } = oMessageBody;
+                Container.setDirtyFlag(bIsDirty);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.Container.registerDirtyStateProvider": {
+            async handler (oMessageBody, oApplicationContainer, oMessageEvent) {
+                const { bRegister } = oMessageBody;
+                if (bRegister) {
+                    oApplicationContainer.addCapabilities([
+                        "sap.ushell.appRuntime.handleDirtyStateProvider"
+                    ]);
+
+                    Container.setAsyncDirtyStateProvider(async (oNavigationContext) => {
+                        // safety check in case post message does not get result
+                        const oNativeDeferred = new Deferred();
+                        const backupTimer = setTimeout(() => {
+                            oNativeDeferred.resolve(false);
+                        }, 2500);
+
+                        oApplicationContainer.sendRequest(
+                            "sap.ushell.appRuntime.handleDirtyStateProvider",
+                            { oNavigationContext },
+                            true // bWaitForResponse
+                        ).then((oResponseMessageBody) => {
+                            if (backupTimer) {
+                                clearTimeout(backupTimer);
+                            }
+
+                            oNativeDeferred.resolve(oResponseMessageBody.result ?? false);
+                        });
+
+                        return oNativeDeferred.promise;
+                    });
+                } else {
+                    Container.setAsyncDirtyStateProvider();
+                }
+            },
+            options: {
+                provideApplicationContext: true
+            }
+        }
+    };
+
+    return {
+        register () {
+            Object.keys(oDistributionPolicies).forEach((sServiceRequest) => {
+                const oDistributionPolicy = oDistributionPolicies[sServiceRequest];
+                PostMessageManager.setDistributionPolicy(sServiceRequest, oDistributionPolicy);
+            });
+
+            Object.keys(oServiceRequestHandlers).forEach((sServiceRequest) => {
+                const oHandler = oServiceRequestHandlers[sServiceRequest];
+                PostMessageManager.setRequestHandler(sServiceRequest, oHandler.handler, oHandler.options);
+            });
+        }
+    };
+});

package/src/main/js/sap/ushell/appIntegration/PostMessageHandler/AppStateHandler.js

@@ -0,0 +1,188 @@
+// Copyright (c) 2009-2025 SAP SE, All Rights Reserved
+/**
+ * @file This file contains the AppStateHandler class.
+ *
+ * AppState handling
+ */
+sap.ui.define([
+    "sap/ui/core/UIComponent",
+    "sap/ui/thirdparty/hasher",
+    "sap/ushell/appIntegration/PostMessageManager",
+    "sap/ushell/Container",
+    "sap/ushell/services/Navigation/compatibility",
+    "sap/ushell/utils"
+], (
+    UIComponent,
+    hasher,
+    PostMessageManager,
+    Container,
+    navigationCompatibility,
+    ushellUtils
+) => {
+    "use strict";
+
+    const oDummyComponent = new UIComponent();
+
+    const oDistributionPolicies = {};
+
+    const oServiceRequestHandlers = {
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState.getAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState.getAppState(sKey);
+
+                const oAppState = await ushellUtils.promisify(oDeferred);
+                delete oAppState._oServiceInstance;
+                return oAppState;
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState._saveAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey, sData, sAppName, sComponent, bTransient, iPersistencyMethod, oPersistencySettings } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState._saveAppState(
+                    sKey,
+                    sData,
+                    sAppName,
+                    sComponent,
+                    bTransient,
+                    iPersistencyMethod,
+                    oPersistencySettings
+                );
+                await ushellUtils.promisify(oDeferred);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState.deleteAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState.deleteAppState(sKey);
+                await ushellUtils.promisify(oDeferred);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.AppState.makeStatePersistent": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sKey, iPersistencyMethod, oPersistencySettings } = oMessageBody;
+                const AppState = await Container.getServiceAsync("AppState");
+
+                const oDeferred = AppState.makeStatePersistent(sKey, iPersistencyMethod, oPersistencySettings);
+                return ushellUtils.promisify(oDeferred);
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.Navigation.getAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sAppStateKey } = oMessageBody;
+                const Navigation = await Container.getServiceAsync("Navigation");
+
+                const oAppState = await Navigation.getAppState(oDummyComponent, sAppStateKey);
+                delete oAppState._oServiceInstance;
+
+                return oAppState;
+            }
+        },
+        /**
+         * @private
+         */
+        "sap.ushell.services.CrossApplicationNavigation.getAppState": {
+            async handler (oMessageBody, oMessageEvent) {
+                const { sAppStateKey } = oMessageBody;
+                const Navigation = await Container.getServiceAsync("Navigation");
+
+                const oAppState = await Navigation.getAppState(oDummyComponent, sAppStateKey);
+                delete oAppState._oServiceInstance;
+
+                return oAppState;
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.CrossApplicationNavigation.getAppStateData": {
+            async handler (oMessageBody, oMessageEvent) {
+                // note: sAppStateKey may be an array of argument arrays
+                const { sAppStateKey: vAppStateKey } = oMessageBody;
+
+                return navigationCompatibility.getAppStateData(vAppStateKey);
+            }
+        },
+        /**
+         * @private
+         * @ui5-restricted SAP internally documented (e.g. for WebGui, WebDynpro, ...)
+         */
+        "sap.ushell.services.CrossApplicationNavigation.setInnerAppStateData": {
+            handler: async (oMessageBody) => {
+                const { sData } = oMessageBody;
+                let oValue;
+
+                if (sData !== undefined) {
+                    try {
+                        oValue = JSON.parse(sData);
+                    } catch (e) {
+                        oValue = sData;
+                    }
+                } else {
+                    oValue = {};
+                }
+
+                const AppState = await Container.getServiceAsync("AppState");
+                const oNewAppState = AppState.createEmptyAppState();
+
+                oNewAppState.setData(oValue);
+                await ushellUtils.promisify(oNewAppState.save());
+                const sNewAppStateKey = oNewAppState.getKey();
+
+                let sHash = hasher.getHash();
+                if (sHash.indexOf("&/") > 0) {
+                    if (sHash.indexOf("sap-iapp-state=") > 0) {
+                        const sCurrAppStateKey = /(?:sap-iapp-state=)([^&/]+)/.exec(sHash)[1];
+                        sHash = sHash.replace(sCurrAppStateKey, sNewAppStateKey);
+                    } else {
+                        sHash = `${sHash}/sap-iapp-state=${sNewAppStateKey}`;
+                    }
+                } else {
+                    sHash = `${sHash}&/sap-iapp-state=${sNewAppStateKey}`;
+                }
+
+                hasher.disableBlueBoxHashChangeTrigger = true;
+                hasher.replaceHash(sHash);
+                hasher.disableBlueBoxHashChangeTrigger = false;
+
+                return sNewAppStateKey;
+            }
+        }
+    };
+
+    return {
+        register () {
+            Object.keys(oDistributionPolicies).forEach((sServiceRequest) => {
+                const oDistributionPolicy = oDistributionPolicies[sServiceRequest];
+                PostMessageManager.setDistributionPolicy(sServiceRequest, oDistributionPolicy);
+            });
+
+            Object.keys(oServiceRequestHandlers).forEach((sServiceRequest) => {
+                const oHandler = oServiceRequestHandlers[sServiceRequest];
+                PostMessageManager.setRequestHandler(sServiceRequest, oHandler.handler, oHandler.options);
+            });
+        }
+    };
+});