@sapui5/sap.ushell_abap 1.152.1 → 1.154.0

package/src/main/js/sap/ushell_abap/components/tiles/applauncherdynamic/DynamicTile.view.js

@@ -0,0 +1,106 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * This copy of the DynamicTile.view is needed for compatibility reasons until the changes to applauncher_dynamic.chip.xml have been delivered.
+ * Afterwards this file can be used in all scenarios and DynamicTile.view.js can be replaced by it.
+ */
+sap.ui.define([
+    "sap/ui/core/mvc/View",
+    "sap/m/GenericTile",
+    "sap/m/TileContent",
+    "sap/m/library",
+    "sap/m/NumericContent",
+    "sap/ushell_abap/components/tiles/applauncherdynamic/DynamicTile.controller" // Controller needs to be loaded
+], (
+    View,
+    GenericTile,
+    TileContent,
+    mobileLibrary,
+    NumericContent
+) => {
+    "use strict";
+
+    // shortcut for sap.m.ValueColor
+    const ValueColor = mobileLibrary.ValueColor;
+
+    return View.extend("sap.ushell_abap.components.tiles.applauncherdynamic.DynamicTile", {
+        getControllerName: function () {
+            return "sap.ushell_abap.components.tiles.applauncherdynamic.DynamicTile";
+        },
+
+        createContent: function () {
+            this.setHeight("100%");
+            this.setWidth("100%");
+
+            return this.getTileControl();
+        },
+
+        getTileControl: function () {
+            const oController = this.getController();
+
+            // Return the GenericTile if it already exists instead of creating a new one
+            if (this.getContent().length === 1) {
+                return this.getContent()[0];
+            }
+
+            return new GenericTile({
+                mode: "{/mode}",
+                frameType: "{/frameType}",
+                header: "{/data/display_title_text}",
+                subheader: "{/data/display_subtitle_text}",
+                sizeBehavior: "{/sizeBehavior}",
+                wrappingType: "{/wrappingType}",
+                appShortcut: "{/config/display_transaction_code_effective}",
+                url: {
+                    parts: ["/targetURL", "/nav/navigation_target_url"],
+                    formatter: oController.formatters.leanURL
+                },
+                tileContent: [new TileContent({
+                    footer: "{/data/display_info_text}",
+                    footerColor: {
+                        path: "/data/display_info_state",
+                        formatter: function (sFooterColor) {
+                            if (sFooterColor === "Positive") {
+                                sFooterColor = ValueColor.Good;
+                            }
+                            if (sFooterColor === "Negative") {
+                                sFooterColor = ValueColor.Error;
+                            }
+
+                            if (!ValueColor[sFooterColor]) {
+                                sFooterColor = ValueColor.Neutral;
+                            }
+
+                            return sFooterColor;
+                        }
+                    },
+                    unit: "{/data/display_number_unit}",
+                    // We'll utilize NumericContent for the "Dynamic" content.
+                    content: [new NumericContent({
+                        scale: "{/data/display_number_factor}",
+                        value: "{/data/display_number_value}",
+                        truncateValueTo: 5, // Otherwise, The default value is 4.
+                        indicator: "{/data/display_state_arrow}",
+                        valueColor: {
+                            path: "/data/display_number_state",
+                            formatter: function (sState) {
+                                if (!sState || sState === "Neutral" || !ValueColor[sState]) {
+                                    return ValueColor.None;
+                                }
+                                return sState;
+                            }
+                        },
+                        icon: "{/data/display_icon_url}",
+                        width: "100%",
+                        withMargin: false
+                    })]
+                })],
+                press: [oController.onPress, oController]
+            });
+        },
+
+        getMode: function () {
+            return this.getModel().getProperty("/mode");
+        }
+    });
+});

package/src/main/js/sap/ushell_abap/library.js

@@ -13,6 +13,13 @@ sap.ui.define([
 ) => {
     "use strict";
 
+    /**
+     * @namespace sap.ushell_abap.api
+     * @since 1.154.0
+     * @private
+     * @ui5-restricted
+     */
+
     /**
      * @namespace sap.ushell_abap.components
      * @since 1.121.0
@@ -32,11 +39,15 @@ sap.ui.define([
     const ushellAbapLib = Library.init({
         name: "sap.ushell_abap",
         apiVersion: 2,
-        version: "1.152.1",
+        version: "1.154.0",
         dependencies: [
             "sap.ui.core",
             "sap.m",
             "sap.ushell"
+        ],
+        controls: [
+            "sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbap",
+            "sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbapLink"
         ]
     });
 

package/src/main/js/sap/ushell_abap/messagebundle.properties

@@ -1,7 +1,11 @@
-#This is the resource bundle for the sap.ushell_abap library
-#__ldi.translation.uuid=865e4af1-8cca-465c-8b85-97f19b98ef6a
+# Resource bundle for the "sap.ushell_abap" library
+# __ldi.translation.uuid=865e4af1-8cca-465c-8b85-97f19b98ef6a
 
 #XBUT: Close button for the SAML authentication dialog
 samlCloseBtn=Close
+
 #XTIT: Title of the SAML authentication dialog
 samlDialogTitle=Authentication Information
+
+#XTXT: Fallback text shown on tiles without transaction code
+tileTransactionCodeNotMaintained=No Transaction

package/src/main/js/sap/ushell_abap/pbServices/ui2/Chip.js

@@ -544,9 +544,13 @@ sap.ui.define([
             };
             const oImplementation = oDefinition.implementation.sapui5;
 
-            // In case the chip is used in FLP wave 2 or later context we load it from the standard path
-            const sBaseChipId = this.getBaseChipId();
-            if ((sBaseChipId !== "X-SAP-UI2-CHIP:/UI2/STATIC_APPLAUNCHER") && (sBaseChipId !== "X-SAP-UI2-CHIP:/UI2/DYNAMIC_APPLAUNCHER")) {
+            const sBaseChipId = this.getBaseChipId() || this.getId(); // base chip id might be empty fallback to actual id
+            const bIsStandardChip = [
+                "X-SAP-UI2-CHIP:/UI2/STATIC_APPLAUNCHER",
+                "X-SAP-UI2-CHIP:/UI2/DYNAMIC_APPLAUNCHER"
+            ].includes(sBaseChipId);
+
+            if (!bIsStandardChip) {
                 if (oImplementation.$VirtualNamespace) {
                     oImplementation.$absolutePath = this.toAbsoluteUrl(oImplementation.basePath);
                     sap.ui.loader.config({ paths: JSON.parse(`{"${oImplementation.$Namespace.replace(/\./g, "/")}":"${oImplementation.$absolutePath}"}`) });

package/src/main/js/sap/ushell_abap/pbServices/ui2/ODataWrapper.js

@@ -117,7 +117,7 @@ sap.ui.define([
         const S_STICKY_SESSION_HEADER = "saplb"; // header to check during sticky session
         let aBatchQueue; // corresponds to data.__batchRequests
         let bChangeSetOpen; // whether a change set is currently open at the end of our batch queue
-        let aDeferredQueue; // jQuery.Deferred() objects corresponding to each request
+        let aDeferredQueue; // Deferreds objects corresponding to each request
         const that = this;
         // eslint-disable-next-line prefer-const
         let sBaseUrl;
@@ -758,7 +758,7 @@ sap.ui.define([
          *   cannot be parsed or is not returned in the OData error response.<br />
          *
          *   <b>NOTE:</b> the second parameter is returned since version 1.28.6.
-         * @param {object} [oDeferred] Deferred object from Promise.withResolvers
+         * @param {PromiseWithResolvers<any>} [oDeferred] Deferred object from Promise.withResolvers
          * @param {object} oError
          *   error object provided by datajs, should contain the response
          *
@@ -859,9 +859,7 @@ sap.ui.define([
          *   Defaults to the OData service facade's default error handler
          *   ({@link sap.ushell_abap.pbServices.ui2.ODataService#getDefaultErrorHandler})
          * @param {boolean} [bCache=false]
-         *   whether the response is cached for further calls (since 1.11.0) in
-         *   <code>OData.read.$cache</code>, a <code>Utils.Map</code> from
-         *   <code>sRequestUrl</code> to a <code>jQuery.Deferred</code> object created on demand;
+         *   whether the response is cached for further calls (since 1.11.0).
          *   without this flag, the cache is neither written nor read!
          *
          * @public

package/src/main/js/sap/ushell_abap/pbServices/ui2/contracts/configuration.js

@@ -4,13 +4,15 @@
  * @fileOverview The <code>configuration</code> contract.
  */
 sap.ui.define([
+    "sap/base/Log",
     "sap/ushell_abap/pbServices/ui2/Chip",
     "sap/ushell_abap/base/Ui2Error",
-    "sap/ushell_abap/base/Ui2Utils"
+    "sap/ushell_abap/utils/UserPersonalization"
 ], (
+    Log,
     Chip,
     SrvcError,
-    Utils
+    UserPersonalization
 ) => {
     "use strict";
 
@@ -43,6 +45,28 @@ sap.ui.define([
             return oChipInstance.getConfigurationParameter(sParameterName);
         };
 
+        /**
+         * Returns the transaction code of the configuration parameter for the CHIP instance.
+         * This is a convenience method for the special configuration parameter "display_transaction_code".
+         *
+         * @name chip.configuration.getTransactionCode
+         * @function
+         * @since 1.153.0
+         * @returns {Promise<string>}
+         *   the parameter transaction code value
+         */
+        this.getTransactionCode = async function () {
+            const sTileConfiguration = oChipInstance.getConfigurationParameter("tileConfiguration");
+            let sTCode;
+            try {
+                sTCode = JSON.parse(sTileConfiguration || "{}").display_transaction_code || "";
+            } catch (oError) {
+                Log.error("Failed to parse tile configuration for transaction code:", oError, "sap.ushell_abap.pbServices.ui2.contracts.configuration");
+            }
+
+            return UserPersonalization.formatTransactionCode(sTCode);
+        };
+
         /**
          * Usually the Page Builder does not know about the internals of a CHIP, but there are special
          * CHIPs (e.g. SAP Fiori Launchpad app launcher tiles, also serving as bookmark tiles) the
@@ -67,10 +91,14 @@ sap.ui.define([
             // The FLP directly changes the configuration data of the bookmark tile and can notify the bookmark
             // tiles afterwards about the changes, so the bookmark tiles can update themselves with the new data.
             if (typeof fnHandler !== "function") {
-                throw new SrvcError("The given handler is not a function",
-                    "chip.configuration");
+                throw new SrvcError("The given handler is not a function", "chip.configuration");
             }
             fnUpdatedHandler = fnHandler;
+
+            // additionally attach to changes on the display transaction code setting
+            UserPersonalization.attachDisplayTransactionCodeChanged(() => {
+                fnHandler(["tileConfiguration"]);
+            });
         };
 
         /**
@@ -101,6 +129,28 @@ sap.ui.define([
                 if (fnUpdatedHandler) {
                     fnUpdatedHandler(aUpdatedConfigKeys);
                 }
+            },
+
+            /**
+             * Returns the transaction code of the configuration parameter for the CHIP instance.
+             * This is a convenience method for the special configuration parameter "display_transaction_code".
+             *
+             * @name contract.configuration.getTransactionCode
+             * @function
+             * @since 1.153.0
+             * @returns {Promise<string>}
+             *   the parameter transaction code value
+             */
+            getTransactionCode: async function () {
+                const sTileConfiguration = oChipInstance.getConfigurationParameter("tileConfiguration");
+                let sTCode;
+                try {
+                    sTCode = JSON.parse(sTileConfiguration || "{}").display_transaction_code || "";
+                } catch (oError) {
+                    Log.error("Failed to parse tile configuration for transaction code:", oError, "sap.ushell_abap.pbServices.ui2.contracts.configuration");
+                }
+
+                return UserPersonalization.formatTransactionCode(sTCode);
             }
         };
     });

package/src/main/js/sap/ushell_abap/services/NavigationDataProvider.js

@@ -9,15 +9,15 @@
  *
  * Configured with the ClientSideTargetResolutionAdapter.
  *
- * @version 1.152.1
+ * @version 1.154.0
  */
 sap.ui.define([
+    "sap/ui/core/Lib",
     "sap/ushell/base/promisify",
-    "sap/ushell/resources",
     "sap/ushell/utils/LaunchpadError"
 ], (
+    Lib,
     promisify,
-    ushellResources,
     LaunchpadError
 ) => {
     "use strict";
@@ -111,7 +111,7 @@ sap.ui.define([
                         oError.message,
                         {
                             component: this.S_COMPONENT_NAME,
-                            description: ushellResources.i18n.getText("NavigationDataProvider.CannotLoadData"),
+                            description: Lib.getResourceBundleFor("sap.ushell").getText("NavigationDataProvider.CannotLoadData"),
                             detail: oError
                         },
                         oError

package/src/main/js/sap/ushell_abap/ui/VisualizationInstantiation/ChipInstanceWrapper.js

@@ -0,0 +1,248 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview Helper class wrapping a CHIP instance for use inside a VizInstance.
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/base/Log",
+    "sap/m/library",
+    "sap/ushell/Container",
+    "sap/ushell/library",
+    "sap/ushell/utils/chipsUtils"
+], (
+    Log,
+    mobileLibrary,
+    Container,
+    ushellLibrary,
+    chipsUtils
+) => {
+    "use strict";
+
+    // shortcut for sap.m.LoadState
+    const LoadState = mobileLibrary.LoadState;
+
+    // shortcut for sap.ushell.DisplayFormat
+    const DisplayFormat = ushellLibrary.DisplayFormat;
+
+    /**
+     * @alias sap.ushell_abap.ui.VisualizationInstantiation.ChipInstanceWrapper
+     * @class
+     * @classdesc Helper class to manage the lifecycle of a CHIP instance inside a VizInstance.
+     * Coordinates chip creation, loading, visibility, and type detection.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    class ChipInstanceWrapper {
+        #oLoadDeferred = Promise.withResolvers();
+        #oChipInstanceDeferred = Promise.withResolvers();
+        #oChipInstance;
+        #oInstantiationData;
+        #oTargetControl;
+        #bInitialized = false;
+
+        /**
+         * @param {sap.ushell.ui.launchpad.VizInstanceBase} oTargetControl The VizInstance that owns this wrapper.
+         */
+        constructor (oTargetControl) {
+            this.#oTargetControl = oTargetControl;
+        }
+
+        /**
+         * Initializes the CHIP instance from the provided instantiation data.
+         * No-op if called more than once.
+         *
+         * @param {object} oInstantiationData The instantiation data from the visualization.
+         * @returns {Promise<undefined>} Resolves when the CHIP instance is created.
+         * @since 1.154.0
+         * @private
+         */
+        async init (oInstantiationData) {
+            if (this.#bInitialized) {
+                return;
+            }
+
+            this.#oInstantiationData = oInstantiationData;
+            this.#bInitialized = true;
+
+            const PageBuilding = await Container.getServiceAsync("PageBuilding");
+            const oFactory = PageBuilding.getFactory();
+
+            let oRawChipInstanceData;
+            let oBags;
+
+            if (!this.#oInstantiationData.simplifiedChipFormat) {
+                oRawChipInstanceData = {
+                    chipId: this.#oInstantiationData?.chip?.id,
+                    chip: this.#oInstantiationData?.chip
+                };
+            } else {
+                const oSimplifiedChip = this.#oInstantiationData?.chip || {};
+                oBags = oSimplifiedChip?.bags;
+                oRawChipInstanceData = {
+                    chipId: oSimplifiedChip?.chipId,
+                    // string is expected
+                    configuration: oSimplifiedChip?.configuration ? JSON.stringify(oSimplifiedChip?.configuration) : "{}"
+                };
+            }
+
+            const oChipInstance = oFactory.createChipInstance(oRawChipInstanceData);
+
+            chipsUtils.addBagDataToChipInstance(oChipInstance, oBags);
+            this.#oChipInstanceDeferred.resolve(oChipInstance);
+        }
+
+        /**
+         * A function which sets the content of the VizInstance to a UI5 view.
+         * @returns {Promise<undefined>} Resolves when the chip instance is loaded.
+         *
+         * @since 1.154.0
+         * @private
+         */
+        async load () {
+            try {
+                this.#oChipInstance = await this.#oChipInstanceDeferred.promise;
+                await new Promise(this.#oChipInstance.load);
+
+                if (this.#oTargetControl.getPreview()) {
+                    const oPreviewContract = this.#oChipInstance.getContract("preview");
+                    // the preview contract doesn't have to be implemented as it might just not be needed
+                    // e.g. for tiles that don't display any dynamic data anyway
+                    if (oPreviewContract) {
+                        oPreviewContract.setEnabled(true);
+                    }
+                }
+                // apply current visibility, default for chips is visible
+                // this might lead to instant requests when tileView is fetched
+                this.setVisible(this.#oTargetControl.getActive());
+
+                const oChipControl = await this.#oChipInstance.getImplementationAsSapui5Async();
+
+                this.#setChipInstanceType();
+                this.#oTargetControl.setContent?.(oChipControl);
+                // Fix parent relation for the component instance to make GridContainer DnD work
+                // BCP: 2170186464
+                if (oChipControl.getComponentInstance?.()) {
+                    oChipControl.getComponentInstance().setParent(this.#oTargetControl);
+                }
+
+                this.#oLoadDeferred.resolve();
+            } catch (oError) {
+                this.#oTargetControl.setState(LoadState.Failed);
+
+                this.#oLoadDeferred.reject(oError);
+            }
+
+            return this.loaded();
+        }
+
+        /**
+         * @returns {Promise<undefined>} Resolves when the chip instance has finished loading.
+         * @since 1.154.0
+         * @private
+         */
+        loaded () {
+            return this.#oLoadDeferred.promise;
+        }
+
+        /**
+         * Returns the transaction code from the inner CHIP instance
+         * Requires {@link #load} to be called first.
+         *
+         * @returns {Promise<string>} Resolves the transaction code to display.
+         *
+         * @since 1.154.0
+         * @private
+         */
+        async getTransactionCode () {
+            await this.#oLoadDeferred.promise;
+
+            return chipsUtils.getCatalogTileTransactionCode(this.#oChipInstance);
+        }
+
+        /**
+         * Sets the display format of the CHIP instance via the instance's types contract
+         *
+         * @since 1.154.0
+         */
+        #setChipInstanceType () {
+            const oTypesContract = this.#oChipInstance.getContract("types");
+            if (oTypesContract) {
+                oTypesContract.setType(this.#mapDisplayFormatToChip(this.#oTargetControl.getDisplayFormat()));
+            }
+        }
+
+        /**
+         * Maps the display format to the CHIP type
+         *
+         * @param {DisplayFormat} sDisplayFormat The display format to be mapped
+         * @returns {string} The appropriate type
+         * @since 1.154.0
+         */
+        #mapDisplayFormatToChip (sDisplayFormat) {
+            const oDisplayFormatMapping = {};
+
+            oDisplayFormatMapping[DisplayFormat.Standard] = "tile";
+            oDisplayFormatMapping[DisplayFormat.StandardWide] = "tile";
+            const oTypesContract = this.#oChipInstance && !this.#oChipInstance.isStub() && this.#oChipInstance.getContract("types");
+            if (oTypesContract && oTypesContract.getAvailableTypes().includes("tilewide")) {
+                oDisplayFormatMapping[DisplayFormat.StandardWide] = "tilewide";
+            }
+            oDisplayFormatMapping[DisplayFormat.Compact] = "link";
+            oDisplayFormatMapping[DisplayFormat.Flat] = "flat";
+            oDisplayFormatMapping[DisplayFormat.FlatWide] = "flatwide";
+
+            return oDisplayFormatMapping[sDisplayFormat];
+        }
+
+        /**
+         * Updates the chip instance's visibility if the contract is active.
+         *
+         * @param {boolean} visible The visibility state to be set
+         * @since 1.154.0
+         */
+        setVisible (visible) {
+            const oVisibleContract = this.#oChipInstance && !this.#oChipInstance.isStub() && this.#oChipInstance.getContract("visible");
+
+            if (oVisibleContract) {
+                oVisibleContract.setVisible(visible);
+            }
+        }
+
+        /**
+         * Refreshes the chip instance's data
+         *
+         * @since 1.154.0
+         */
+        refresh () {
+            // The CHIP instance is only available after the VizInstance was loaded
+            if (this.#oChipInstance) {
+                // The refresh handler is provided directly on the CHIP instance and not as contract
+                this.#oChipInstance.refresh();
+            }
+        }
+
+        /**
+         * Returns whether the VizInstance is a standard tile type.
+         * @returns {boolean} Whether the VizInstance is standard.
+         *
+         * @since 1.154.0
+         * @private
+         */
+        isStandardType () {
+            // check whether the chip instance is a standard tile or a custom tile based on the base chip ID.
+            // simplified format -> chip.chipId, non-simplified (raw) format -> chip.baseChipId
+            if (!this.#oInstantiationData?.chip) {
+                Log.warning("VizInstanceAbap: No instantiation data available to determine whether the VizInstance is a standard tile or a custom tile.");
+                return false;
+            }
+            const sBaseChipId = this.#oInstantiationData.simplifiedChipFormat
+                ? this.#oInstantiationData.chip.chipId
+                : this.#oInstantiationData.chip.baseChipId;
+            return chipsUtils.isStandardTile(sBaseChipId);
+        }
+    }
+
+    return ChipInstanceWrapper;
+});