@sapui5/sap.ushell_abap 1.152.1 → 1.154.0

package/src/main/js/sap/ushell_abap/components/SideNavigation/modules/GenericNavigationListProvider.js

@@ -0,0 +1,241 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/base/Log",
+    "sap/tnt/NavigationList",
+    "sap/ushell/base/requireAsync",
+    "sap/ushell/Config",
+    "sap/ushell/modules/NavigationMenu/ListProvider"
+], (
+    Log,
+    NavigationList,
+    requireAsync,
+    Config,
+    ListProvider
+) => {
+    "use strict";
+    /**
+     * The NavigationList for the item aggregation of the SideNavigation.
+     *
+     * This module depends on the following ushell configuration:
+     *
+     * <code>
+     * /core/menu/personalization/enabled
+     * /core/spaces/myHome/enabled
+     * /core/spaces/myHome/myHomeSpaceId
+     * /core/spaces/myHome/myHomeSpaceId
+     * </code>
+     *
+     * Module specific configuration can contain the following properties as a stringified JSON object:
+     * <code>
+     * /core/sideNavigation/navigationListProvider/configuration
+     * {
+     *     recentActivity: {
+     *         enabled: true,
+     *         maxItems: 10
+     *     },
+     *     favorites: {
+     *         enabled: true
+     *     },
+     *     spaces: {
+     *         enabled: true,
+     *         defaultIcon: ""
+     *     }
+     * }
+     * </code>
+     *
+     * @augments sap.ushell.modules.NavigationMenu.ListProvider
+     *
+     * @since 1.154.0
+     * @private
+     */
+    class GenericNavigationListProvider extends ListProvider {
+        /**
+         * The side navigation API object passed to the constructor.
+         * @type {sap.ushell.modules.NavigationMenu.ListProviderAPI}
+         */
+        #oSideNavAPI;
+
+        /**
+         * The root navigation list.
+         * @type {sap.tnt.NavigationList}
+         */
+        #oRootItem;
+
+        /**
+         * Instance of the MyHome module.
+         * @type {object}
+         */
+        #oMyHome;
+
+        /**
+         * Instance of the RecentActivity module.
+         * @type {object}
+         */
+        #oRecentActivity;
+
+        /**
+         * Instance of the Favorites module.
+         * @type {object}
+         */
+        #oFavorites;
+
+        /**
+         * Instance of the Spaces module.
+         * @type {object}
+         */
+        #oSpaces;
+
+        #oInitDeferred = Promise.withResolvers();
+
+        /**
+         * Creates a NavigationList for the item aggregation of the SideNavigation.
+         *
+         * @param {sap.ushell.modules.NavigationMenu.ListProviderAPI} oSideNavAPI The side navigation API object.
+         *
+         * @since 1.154.0
+         * @private
+         */
+        constructor (oSideNavAPI) {
+            super(oSideNavAPI);
+
+            this.#oSideNavAPI = oSideNavAPI;
+            this.#oRootItem = new NavigationList();
+
+            this.#buildSideNavigation().finally(this.#oInitDeferred.resolve);
+        }
+
+        /**
+         * @returns {Promise} Resolves once the init is done.
+         */
+        #initialized () {
+            return this.#oInitDeferred.promise;
+        }
+
+        /**
+        * Asynchronously retrieves the root navigation item.
+        *
+        * @async
+        * @returns {Promise<sap.tnt.NavigationList>} A promise that resolves to NavigationList with the configuration menu items.
+        * @since 1.154.0
+        */
+        async getRootItem () {
+            await this.#initialized();
+
+            return this.#oRootItem;
+        }
+
+        /**
+        * Asynchronously retrieves the selected item key from the spaces.
+        * @returns {Promise<string>} A promise that resolves to the selected item key.
+        * @since 1.154.0
+        */
+        async findSelectedKey () {
+            await this.#initialized();
+
+            let sSelectedKey = await this.#oMyHome?.findSelectedKey();
+            if (!sSelectedKey) {
+                sSelectedKey = await this.#oSpaces?.findSelectedKey();
+            }
+            return sSelectedKey;
+        }
+
+        /**
+        * Builds the side navigation structure by dynamically loading and configuring navigation modules.
+        * This method initializes child navigation items based on the configuration settings provided.
+        *
+        * @private
+        * @since 1.154.0
+        */
+        async #buildSideNavigation () {
+            this.oChildItems = {};
+
+            if (Config.last("/core/spaces/myHome/userEnabled")
+                && Config.last("/core/spaces/myHome/enabled")) {
+                try {
+                    const [MyHome] = await requireAsync(["sap/ushell/components/shell/SideNavigation/modules/MyHome"]);
+
+                    this.#oMyHome = new MyHome(this.#oSideNavAPI);
+                    const oRootItem = await this.#oMyHome.getRootItem();
+                    this.oChildItems.myHome = oRootItem;
+                    this.#addItemsToAggregation();
+                } catch (oError) {
+                    Log.error("Error loading MyHome module:", oError, "SideNavigation");
+                }
+            }
+
+            if (this.#oSideNavAPI.getConfigValue("recentActivity.enabled")) {
+                try {
+                    const [RecentActivity] = await requireAsync(["sap/ushell/components/shell/SideNavigation/modules/RecentActivity"]);
+
+                    this.#oRecentActivity = new RecentActivity(this.#oSideNavAPI);
+                    const oRootItem = await this.#oRecentActivity.getRootItem();
+                    this.oChildItems.recentActivity = oRootItem;
+                    this.#addItemsToAggregation();
+                } catch (oError) {
+                    Log.error("Error loading RecentActivity module:", oError, "SideNavigation");
+                }
+            }
+
+            if (this.#oSideNavAPI.getConfigValue("favorites.enabled")
+                && Config.last("/core/spaces/myHome/userEnabled")
+                && Config.last("/core/spaces/myHome/enabled")) {
+                try {
+                    const [Favorites] = await requireAsync(["sap/ushell_abap/components/SideNavigation/modules/Favorites"]);
+
+                    this.#oFavorites = new Favorites(this.#oSideNavAPI);
+                    const oRootItem = await this.#oFavorites.getRootItem();
+                    this.oChildItems.favorites = oRootItem;
+                    this.#addItemsToAggregation();
+                } catch (oError) {
+                    Log.error("Error loading Favorites module:", oError, "SideNavigation");
+                }
+            }
+
+            if (this.#oSideNavAPI.getConfigValue("spaces.enabled")) {
+                try {
+                    const [Spaces] = await requireAsync(["sap/ushell/components/shell/SideNavigation/modules/Spaces"]);
+
+                    this.#oSpaces = new Spaces(this.#oSideNavAPI);
+                    const oRootItem = await this.#oSpaces.getRootItem();
+                    this.oChildItems.spaces = oRootItem;
+                    this.#addItemsToAggregation();
+                } catch (oError) {
+                    Log.error("Error loading Spaces module:", oError, "SideNavigation");
+                }
+            }
+        }
+
+        /**
+         * Adds the child items to the root item's aggregation.
+         *
+         * @since 1.154.0
+         * @private
+         */
+        #addItemsToAggregation () {
+            this.#oRootItem.addAggregation("items", this.oChildItems.myHome);
+            this.#oRootItem.addAggregation("items", this.oChildItems.recentActivity);
+            this.#oRootItem.addAggregation("items", this.oChildItems.favorites);
+            this.#oRootItem.addAggregation("items", this.oChildItems.spaces);
+        }
+
+        /**
+         * Cleans up the component instance.
+         *
+         * @since 1.154.0
+         * @private
+         */
+        async exit () {
+            await this.#initialized();
+
+            this.#oMyHome?.destroy();
+            this.#oRecentActivity?.destroy();
+            this.#oFavorites?.destroy();
+            this.#oSpaces?.destroy();
+
+            this.#oRootItem.destroy();
+        }
+    }
+
+    return GenericNavigationListProvider;
+});

package/src/main/js/sap/ushell_abap/components/cards/Card.controller.js

@@ -0,0 +1,117 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+sap.ui.define([
+    "sap/ushell/components/tiles/utils",
+    "sap/ushell_abap/components/cards/ManifestPropertyHelper",
+    "sap/ushell/library",
+    "sap/ui/core/mvc/Controller",
+    "sap/ui/model/json/JSONModel",
+    "sap/ui/core/mvc/XMLView",
+    "sap/ushell/Container"
+], (
+    tileUtils,
+    manifestPropertyHelper,
+    ushellLibrary,
+    Controller,
+    JSONModel,
+    XMLView,
+    Container
+) => {
+    "use strict";
+
+    return Controller.extend("sap.ushell_abap.components.cards.Card", {
+        onInit: function () {
+            const oView = this.getView();
+            const oChipInstance = this.getView().getViewData().chip;
+            const oTilePropertiesBag = oChipInstance.bag.getBag("tileProperties");
+
+            const oCardData = manifestPropertyHelper.getTranslatablePropertiesFromBag(oTilePropertiesBag);
+
+            const oModel = new JSONModel({
+                data: oCardData
+            });
+            oView.setModel(oModel);
+            oView.setModel(ushellLibrary.getResourceModel(), "i18n");
+
+            this._implementConfigurationUiContract(oChipInstance, oView);
+            this._implementPreviewContract(oChipInstance, oCardData);
+        },
+
+        // trigger to show the configuration UI if the tile is pressed in Admin mode
+        onPress: function () {
+            const oView = this.getView();
+            const oChipInstance = oView.getViewData().chip;
+            const sCardTileConfiguration = oChipInstance.configuration.getParameterValueAsString("tileConfiguration");
+            let oCardTileConfiguration;
+
+            if (oChipInstance.configurationUi.isEnabled()) {
+                oChipInstance.configurationUi.display();
+            } else if (sCardTileConfiguration) {
+                oCardTileConfiguration = JSON.parse(sCardTileConfiguration);
+
+                Container.getServiceAsync("Navigation").then((oNavigation) => {
+                    oNavigation.navigate({
+                        target: {
+                            semanticObject: oCardTileConfiguration.navigation_semantic_object,
+                            action: oCardTileConfiguration.navigation_semantic_action
+                        },
+                        params: oCardTileConfiguration.navigation_semantic_parameters_as_object
+                    });
+                });
+            }
+        },
+
+        /**
+         * @param {object} chipInstance The card's chip instance
+         * @param {object} cardData The card's translatable properties. Only title and subtitle are needed.
+         *
+         * @private
+         */
+        _implementPreviewContract: function (chipInstance, cardData) {
+            if (chipInstance.preview) {
+                chipInstance.preview.setPreviewTitle(cardData.display_title_text);
+                if (chipInstance.preview.setPreviewSubtitle && typeof chipInstance.preview.setPreviewSubtitle === "function") {
+                    chipInstance.preview.setPreviewSubtitle(cardData.display_subtitle_text);
+                }
+            }
+        },
+
+        /**
+         * Adds the configuration view to the configuration contract and binds the tilemodel to it.
+         *
+         * @param {object} chipInstance The card's chip instance
+         * @param {object} view The card's view
+         *
+         * @private
+         */
+        _implementConfigurationUiContract: function (chipInstance, view) {
+            if (chipInstance.configurationUi && chipInstance.configurationUi.isEnabled()) {
+                chipInstance.configurationUi.setUiProvider(() => {
+                    const oConfigurationUi = this._getConfigurationUi(chipInstance);
+                    oConfigurationUi.setModel(view.getModel(), "tileModel");
+                    return oConfigurationUi;
+                });
+
+                view.getContent()[0].setTooltip(
+                    tileUtils.getResourceBundle().getText("edit_configuration.tooltip")
+                );
+            }
+        },
+
+        /**
+         * Builds a configuration UI for the card.
+         *
+         * @param {object} chipInstance The card's chip instance
+         * @returns {object} The card's configuration view
+         * @private
+         */
+        _getConfigurationUi: function (chipInstance) {
+            const oConfigurationView = new XMLView({
+                viewName: "sap.ushell_abap.components.cards.Configuration",
+                viewData: { chipInstance: chipInstance }
+            });
+
+            return oConfigurationView;
+        }
+    });
+});

package/src/main/js/sap/ushell_abap/components/cards/Card.view.xml

@@ -0,0 +1,11 @@
+<mvc:View
+    xmlns="sap.m"
+    xmlns:mvc="sap.ui.core.mvc"
+    controllerName="sap.ushell_abap.components.cards.Card">
+    <GenericTile
+        header="{/data/display_title_text}"
+        subheader="{/data/display_subtitle_text}"
+        press=".onPress">
+        <TileContent footer="{i18n>cardTileCaption}" />
+    </GenericTile>
+</mvc:View>

package/src/main/js/sap/ushell_abap/components/cards/Configuration.controller.js

@@ -0,0 +1,280 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+sap.ui.define([
+    "sap/base/i18n/Localization",
+    "sap/ui/core/Locale",
+    "sap/ui/core/Lib",
+    "sap/ushell_abap/components/cards/ManifestPropertyHelper",
+    "sap/ushell/library",
+    "sap/ui/core/mvc/Controller",
+    "sap/base/strings/formatMessage",
+    "sap/ui/model/json/JSONModel",
+    "sap/base/Log",
+    "sap/ushell/utils/LaunchpadError"
+], (Localization, Locale, Lib, manifestPropertyHelper, ushellLibrary, Controller, formatter, JSONModel, Log, LaunchpadError) => {
+    "use strict";
+
+    return Controller.extend("sap.ushell_abap.components.cards.Configuration", {
+        formatter: formatter,
+        onInit: function () {
+            const oView = this.getView();
+            const oViewData = oView.getViewData();
+            const oChipInstance = oViewData.chipInstance;
+            const sManifest = oChipInstance.configuration.getParameterValueAsString("cardManifest");
+            let oManifest;
+
+            if (sManifest) {
+                oManifest = this._prepareManifest(sManifest, oChipInstance);
+            }
+
+            const oModel = new JSONModel({
+                data: {
+                    editorValue: JSON.stringify(oManifest, null, 4) || ""
+                },
+                config: {
+                    originalLanguage: "",
+                    sapLogonLanguage: "",
+                    displayOriginalLanguageWarning: false,
+                    manifestEditorEditable: true
+                }
+            });
+            oView.setModel(oModel);
+            oView.setModel(ushellLibrary.getResourceModel(), "i18n");
+
+            oView.setViewName("sap.ushell_abap.components.cards.Configuration");
+
+            oChipInstance.configurationUi.attachSave(this.onSaveConfiguration.bind(this));
+
+            this._checkOriginalLanguage();
+        },
+
+        onSaveConfiguration: async function () {
+            const oModel = this.getView().getModel();
+            const sManifest = oModel.getProperty("/data/editorValue");
+            let oManifest;
+
+            try {
+                oManifest = JSON.parse(sManifest);
+            } catch (oError) {
+                Log.error(Lib.getResourceBundleFor("sap.ushell").getText("configuration.invalidJSONProvided"), oError, "card.Configuration.controller");
+                throw oError;
+            }
+
+            const oExtractedCardData = manifestPropertyHelper.extractCardData(oManifest);
+
+            try {
+                await this._saveManifestAndTileConfig(oExtractedCardData.manifest, oExtractedCardData.tileConfiguration);
+                await this._saveTilePropertiesBag(oExtractedCardData);
+                await this._saveTitle(oExtractedCardData.bagProperties.display_title_text);
+                this._updateTileModel(oExtractedCardData);
+            } catch (oError) {
+                Log.error("save failed", oError, "card.Configuration.controller");
+                throw oError;
+            }
+        },
+
+        /**
+         * Saves the card's manifest and configuration via the CHIP API
+         *
+         * @param {object} manifest The card's manifest
+         * @param {object} tileConfiguration The card's configuration
+         * @returns {Promise} A promise that resolves when the data has been saved successfully
+         * @private
+         */
+        _saveManifestAndTileConfig: function (manifest, tileConfiguration) {
+            const oChipInstance = this.getView().getViewData().chipInstance;
+
+            const oPromise = new Promise((resolve, reject) => {
+                // use configuration contract to write parameter values
+                oChipInstance.writeConfiguration.setParameterValues(
+                    {
+                        cardManifest: JSON.stringify(manifest),
+                        // this has to be called tileConfiguration also for cards as the FLP expects
+                        // to find the configuration under this name
+                        tileConfiguration: tileConfiguration
+                    },
+                    resolve,
+                    (sErrorMessage, oErrorInfo) => {
+                        const oError = new LaunchpadError(
+                            sErrorMessage,
+                            {
+                                error: sErrorMessage,
+                                errorInfo: oErrorInfo
+                            }
+                        );
+                        reject(oError);
+                    }
+                );
+            });
+
+            return oPromise;
+        },
+
+        /**
+         * Saves the card's translatable properies in a property bag via the CHIP API
+         *
+         * @param {object} cardData The card's data
+         * @returns {Promise} A promise that resolves when the data has been saved successfully
+         * @private
+         */
+        _saveTilePropertiesBag: function (cardData) {
+            const oChipInstance = this.getView().getViewData().chipInstance;
+            const oTilePropertiesBag = oChipInstance.bag.getBag("tileProperties");
+            this._fillCardBag(cardData, oTilePropertiesBag);
+
+            const oPromise = new Promise((resolve, reject) => {
+                oTilePropertiesBag.save(
+                    resolve,
+                    (mErrorMessages, mErrorInfo) => {
+                        const sFirstFailedBag = Object.keys(mErrorMessages)[0];
+
+                        reject(new LaunchpadError(`Bag save failed: ${mErrorMessages[sFirstFailedBag]}`, {
+                            info: mErrorInfo[sFirstFailedBag],
+                            otherMessages: mErrorMessages,
+                            otherInfo: mErrorInfo
+                        }));
+                    }
+                );
+            });
+
+            return oPromise;
+        },
+
+        /**
+         * Saves the card's title via the CHIP API
+         *
+         * @param {string} title The card's title
+         * @returns {Promise} A promise that resolves when the data has been saved successfully
+         * @private
+         */
+        _saveTitle: function (title) {
+            const oChipInstance = this.getView().getViewData().chipInstance;
+
+            const oPromise = new Promise((resolve, reject) => {
+                // the chip has a separate title property that is kept in sync with the title in the bags here
+                if (oChipInstance.title) {
+                    oChipInstance.title.setTitle(
+                        title,
+                        resolve,
+                        (sErrorMessage, oErrorInfo) => {
+                            const oEnhancedError = new LaunchpadError(
+                                sErrorMessage,
+                                {
+                                    error: sErrorMessage,
+                                    errorInfo: oErrorInfo
+                                }
+                            );
+                            reject(oEnhancedError);
+                        }
+                    );
+                } else {
+                    resolve();
+                }
+            });
+
+            return oPromise;
+        },
+
+        /**
+         * Update the title and subtitle of the card tile' model
+         *
+         * @param {string} cardData The card data
+         * @private
+         */
+        _updateTileModel: function (cardData) {
+            const oTileModel = this.getView().getModel("tileModel");
+
+            // update the tile model in order to show the current information on the previewed tile outside the configuration UI
+            oTileModel.setProperty("/data/display_title_text", cardData.bagProperties.display_title_text);
+            oTileModel.setProperty("/data/display_subtitle_text", cardData.bagProperties.display_subtitle_text);
+        },
+
+        /**
+         * Fill the card's CHIP bag with texts extracted from the card's manifest
+         *
+         * @param {object} extractedData The card data extraced from the manifest
+         * @param {object} tilePropertiesBag The card's properties bag
+         *
+         * @private
+         */
+        _fillCardBag: function (extractedData, tilePropertiesBag) {
+            Object.keys(extractedData.bagProperties).forEach((sProperty) => {
+                if (extractedData.bagProperties[sProperty]) {
+                    tilePropertiesBag.setText(sProperty, extractedData.bagProperties[sProperty]);
+                } else {
+                    tilePropertiesBag.resetProperty(sProperty);
+                }
+            });
+        },
+
+        /**
+         * Merges the card's bag properties into the card's manifest
+         *
+         * @param {string} manifest The card's raw manifest
+         * @param {*} chipInstance The card's chip instance
+         *
+         * @returns {object} The merged data
+         *
+         * @private
+         */
+        _prepareManifest: function (manifest, chipInstance) {
+            const oManifest = JSON.parse(manifest);
+            const oCardData = manifestPropertyHelper.getCardData(chipInstance);
+
+            return manifestPropertyHelper.mergeCardData(oManifest, oCardData);
+        },
+
+        /**
+         * Checks wether the user is logged in in the original language of the card.
+         * Displays a warning message and sets the manifest editor to read only if not.
+         *
+         * @private
+         */
+        _checkOriginalLanguage: function () {
+            let oModel;
+            let oLanguages;
+
+            if (!this._isOriginalLanguage()) {
+                oModel = this.getView().getModel();
+                oLanguages = this._getLanguages();
+
+                oModel.setProperty("/config/originalLanguage", oLanguages.originalLanguage.toUpperCase());
+                oModel.setProperty("/config/sapLogonLanguage", oLanguages.logonLanguage.toUpperCase());
+                oModel.setProperty("/config/displayOriginalLanguageWarning", true);
+                oModel.setProperty("/config/manifestEditorEditable", false);
+            }
+        },
+
+        /**
+         * Checks wether the user is logged in in the original language of the card.
+         *
+         * @returns {boolean} Is it the original language?
+         *
+         * @private
+         */
+        _isOriginalLanguage: function () {
+            const oLanguages = this._getLanguages();
+            const sOriginalLanguage = oLanguages.originalLanguage.toLowerCase();
+            const sSAPLogonLanguage = oLanguages.logonLanguage.toLowerCase();
+            const sLanguage = oLanguages.ui5CoreLanguage.toLowerCase();
+
+            return sOriginalLanguage === "" || sOriginalLanguage === sSAPLogonLanguage || sOriginalLanguage === sLanguage;
+        },
+
+        /**
+         * Retrieves the original language of the card chip instance and the user's logon language
+         *
+         * @returns {object} Original and logon language
+         *
+         * @private
+         */
+        _getLanguages: function () {
+            const chipInstance = this.oView.getViewData().chipInstance;
+
+            return {
+                originalLanguage: chipInstance.bag.getOriginalLanguage(),
+                logonLanguage: new Locale(Localization.getLanguageTag()).getSAPLogonLanguage(),
+                ui5CoreLanguage: Localization.getLanguage()
+            };
+        }
+    });
+});

package/src/main/js/sap/ushell_abap/components/cards/Configuration.view.xml

@@ -0,0 +1,27 @@
+<mvc:View
+    xmlns="sap.m"
+    xmlns:mvc="sap.ui.core.mvc"
+    xmlns:codeeditor="sap.ui.codeeditor"
+    controllerName="sap.ushell_abap.components.cards.Configuration"
+    height="100%">
+    <VBox fitContainer="true" justifyContent="SpaceBetween">
+        <MessageStrip
+            id="messageStrip"
+            showIcon="true"
+            showCloseButton="false"
+            type="Warning"
+            visible="{/config/displayOriginalLanguageWarning}"
+            text="{
+                parts: [
+                    'i18n>edit_configuration.original_locale_not_fit_message',
+                    '/config/originalLanguage',
+                    '/config/sapLogonLanguage'
+                ],
+                'formatter': '.formatter'
+            }" />
+        <Title text="{i18n>configuration.category.card_manifest}" class="sapUiTinyMargin" />
+        <codeeditor:CodeEditor id="manifestEditor" value="{/data/editorValue}" editable="{/config/manifestEditorEditable}" type="json">
+            <codeeditor:layoutData><FlexItemData growFactor="1" /></codeeditor:layoutData>
+        </codeeditor:CodeEditor>
+    </VBox>
+</mvc:View>