@sapui5/sap.ushell_abap 1.152.1 → 1.154.0

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

@@ -0,0 +1,134 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview VizInstance implementation for the ABAP platform, backed by a CHIP instance.
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/ushell/ui/launchpad/VizInstance",
+    "sap/ushell_abap/ui/VisualizationInstantiation/ChipInstanceWrapper"
+], (
+    VizInstance,
+    ChipInstanceWrapper
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbap
+     * @class
+     * @classdesc VizInstance for visualizations sourced from the ABAP platform.
+     * Delegates rendering and data loading to a {@link sap.ushell_abap.ui.VisualizationInstantiation.ChipInstanceWrapper}.
+     *
+     * @extends sap.ushell.ui.launchpad.VizInstance
+     *
+     * @since 1.77
+     * @private
+     */
+    const VizInstanceAbap = VizInstance.extend("sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbap", /** @lends sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbap.prototype */ {
+        metadata: {
+            library: "sap.ushell_abap"
+        },
+        renderer: VizInstance.getMetadata().getRenderer()
+    });
+
+    /**
+     * @override
+     * @since 1.77
+     * @private
+     */
+    VizInstanceAbap.prototype.init = function () {
+        VizInstance.prototype.init.apply(this, arguments);
+
+        this._oChipInstanceWrapper = new ChipInstanceWrapper(this);
+    };
+
+    /**
+     * Initializes the underlying CHIP instance with the provided instantiation data.
+     *
+     * @param {object} oInstantiationData The instantiation data for the CHIP.
+     * @returns {sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbap} This instance, for chaining.
+     * @override
+     * @since 1.77
+     * @private
+     */
+    VizInstanceAbap.prototype.setInstantiationData = function (oInstantiationData) {
+        this._oChipInstanceWrapper.init(oInstantiationData);
+        this.setProperty("instantiationData", oInstantiationData);
+        return this;
+    };
+
+    /**
+     * A function which sets the content of the VizInstance to a UI5 view.
+     * @param {boolean} [isCustom] Whether this VizInstance is a standard tile or custom.
+     * @returns {Promise<undefined>} Resolves when the chip instance is loaded.
+     * @override
+     * @since 1.77
+     */
+    VizInstanceAbap.prototype.load = function (isCustom) {
+        return this._oChipInstanceWrapper.load();
+    };
+
+    /**
+     * @returns {Promise<undefined>} Resolves when the chip instance has finished loading.
+     * @override
+     * @since 1.77
+     * @private
+     */
+    VizInstanceAbap.prototype.loaded = function () {
+        return this._oChipInstanceWrapper.loaded();
+    };
+
+    /**
+     * 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
+     */
+    VizInstanceAbap.prototype.getTransactionCode = async function () {
+        return this._oChipInstanceWrapper.getTransactionCode();
+    };
+
+    /**
+     * Refreshes the chip instance's data
+     *
+     * @since 1.78
+     */
+    VizInstanceAbap.prototype.refresh = function () {
+        this._oChipInstanceWrapper.refresh();
+    };
+
+    /**
+     * Updates the visualization's active state.
+     * E.g. inactive dynamic tiles do not send requests
+     *
+     * @param {boolean} active The visualization's active state
+     * @param {boolean} refresh Refresh the visualization immediately
+     * @returns {object} The VizInstance
+     * @since 1.78
+     */
+    VizInstanceAbap.prototype.setActive = function (active, refresh) {
+        this._oChipInstanceWrapper.setVisible(active);
+
+        if (refresh) {
+            this.refresh();
+        }
+
+        return this.setProperty("active", active, false);
+    };
+
+    /**
+     * Returns whether the VizInstance is a standard tile type.
+     * @returns {boolean} Whether the VizInstance is standard.
+     * @override
+     * @since 1.153
+     * @private
+     */
+    VizInstanceAbap.prototype.isStandardType = function () {
+        return this._oChipInstanceWrapper.isStandardType();
+    };
+
+    return VizInstanceAbap;
+});

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

@@ -0,0 +1,145 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview VizInstance link implementation for the ABAP platform, displaying the TCode as a shortcut.
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/ushell/ui/launchpad/VizInstanceLink",
+    "sap/ushell_abap/ui/VisualizationInstantiation/ChipInstanceWrapper",
+    "sap/ushell_abap/utils/UserPersonalization"
+], (
+    VizInstanceLink,
+    ChipInstanceWrapper,
+    UserPersonalization
+) => {
+    "use strict";
+
+    /**
+     * @alias sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbapLink
+     * @class
+     * @classdesc VizInstance for compact ABAP link tiles backed by a CHIP instance,
+     * displaying the transaction code as an app shortcut.
+     *
+     * @param {string} [sId] ID for the new managed object; generated automatically if no non-empty ID is given
+     * @param {object} [mSettings] Optional map/JSON-object with initial property values, aggregated objects etc. for the new object
+     *
+     * @extends sap.ushell.ui.launchpad.VizInstanceLink
+     *
+     * @since 1.154.0
+     *
+     * @private
+     */ // eslint-disable-next-line max-len
+    const VizInstanceAbapLink = VizInstanceLink.extend("sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbapLink", /** @lends sap.ushell_abap.ui.VisualizationInstantiation.VizInstanceAbapLink.prototype */ {
+        metadata: {
+            library: "sap.ushell_abap"
+        },
+        renderer: VizInstanceLink.getMetadata().getRenderer()
+    });
+
+    /**
+     * Lifecycle method which is called on create
+     *
+     * @since 1.154.0
+     * @private
+     */
+    VizInstanceAbapLink.prototype.init = function () {
+        VizInstanceLink.prototype.init.apply(this, arguments);
+
+        // prepare chip
+        this._oChipInstanceWrapper = new ChipInstanceWrapper(this);
+
+        this._fetchAndUpdateTransactionCode();
+
+        UserPersonalization.attachDisplayTransactionCodeChanged(this._fetchAndUpdateTransactionCode, this);
+    };
+
+    /**
+     * Fetches the transaction code and updates the internal value
+     *
+     * @returns {Promise} Resolves once updated
+     *
+     * @since 1.154.0
+     * @private
+     */
+    VizInstanceAbapLink.prototype._fetchAndUpdateTransactionCode = async function () {
+        const sTransactionCode = await this._oChipInstanceWrapper.getTransactionCode();
+        this.setAppShortcut(sTransactionCode);
+    };
+
+    /**
+     * Initializes the underlying CHIP instance with the provided instantiation data.
+     *
+     * @param {object} oInstantiationData The instantiation data for the CHIP.
+     * @returns {this} This instance, for chaining.
+     * @override
+     * @since 1.154.0
+     * @private
+     */
+    VizInstanceAbapLink.prototype.setInstantiationData = function (oInstantiationData) {
+        this._oChipInstanceWrapper.init(oInstantiationData);
+        this.setProperty("instantiationData", oInstantiationData);
+        return this;
+    };
+
+    /**
+     * Loads the underlying CHIP instance.
+     *
+     * @returns {Promise<undefined>} Resolves when the chip instance is loaded.
+     * @override
+     * @since 1.154.0
+     * @private
+     */
+    VizInstanceAbapLink.prototype.load = function () {
+        return this._oChipInstanceWrapper.load();
+    };
+
+    /**
+     * @returns {Promise<undefined>} Resolves when the chip instance has finished loading.
+     * @override
+     * @since 1.154.0
+     * @private
+     */
+    VizInstanceAbapLink.prototype.loaded = function () {
+        return this._oChipInstanceWrapper.loaded();
+    };
+
+    /**
+     * Returns whether the VizInstanceAbapLink is a standard tile type.
+     * @returns {boolean} Whether the VizInstanceAbapLink is standard.
+     * @since 1.154.0
+     * @private
+     */
+    VizInstanceAbapLink.prototype.isStandardType = function () {
+        return this._oChipInstanceWrapper.isStandardType();
+    };
+
+    /**
+     * 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
+     */
+    VizInstanceAbapLink.prototype.getTransactionCode = async function () {
+        return this._oChipInstanceWrapper.getTransactionCode();
+    };
+
+    /**
+     * Lifecycle method which is called on destroy
+     *
+     * @since 1.154.0
+     * @private
+     */
+    VizInstanceAbapLink.prototype.exit = function () {
+        UserPersonalization.detachDisplayTransactionCodeChanged(this._fetchAndUpdateTransactionCode, this);
+
+        if (VizInstanceLink.prototype.exit) {
+            VizInstanceLink.prototype.exit.apply(this, arguments);
+        }
+    };
+
+    return VizInstanceAbapLink;
+});

package/src/main/js/sap/ushell_abap/utils/UserPersonalization.js

@@ -0,0 +1,127 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+/**
+ * @fileOverview The ABAP platform's helper module to handle personalized settings values
+ *
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/ui/base/EventProvider",
+    "sap/ui/core/Lib",
+    "sap/ushell/Config",
+    "sap/ushell/User/UserPersonalization"
+], (
+    EventProvider,
+    Lib,
+    Config,
+    UshellUserPersonalization
+) => {
+    "use strict";
+    class UserPersonalization {
+        #oEventProvider = new EventProvider();
+
+        /**
+         * Resolves the formatted transaction code to display on a tile.
+         *
+         * Returns the raw tcode when admin and user settings both permit display, a placeholder
+         * text when the feature is active but no tcode is configured, or an empty string when
+         * the feature is disabled (admin flag or user toggle).
+         *
+         * @param {string} sTransactionCode The raw transaction code from the tile configuration.
+         * @returns {Promise<string>} Resolves to the formatted display value.
+         *
+         * @since 1.153.0
+         * @private
+         */
+        async formatTransactionCode (sTransactionCode) {
+            const bShowTCode = await this.getDisplayTransactionCode();
+            if (!bShowTCode) {
+                return "";
+            }
+            if (sTransactionCode) {
+                return sTransactionCode.toUpperCase();
+            }
+            return Lib.getResourceBundleFor("sap.ushell_abap").getText("tileTransactionCodeNotMaintained").toUpperCase();
+        }
+
+        /**
+         * Handles the different setting options
+         *
+         * 1) Admin enablement ("/abap/ui/displayTransaction")
+         * 2) User enablement (personalization setting "showTransactionCode")
+         *
+         * @returns {Promise<boolean>} Resolves to whether the transaction code should be shown.
+         *
+         * @since 1.153.0
+         * @private
+         */
+        async getDisplayTransactionCode () {
+            if (Config.last("/abap/ui/displayTransaction") !== "Display_AllowUser") {
+                // feature off -> hidden; the user toggle is irrelevant
+                return false;
+            }
+            try {
+                const bValue = await UshellUserPersonalization.getItemValue("showTransactionCode");
+                return typeof bValue === "undefined" ? true : !!bValue;
+            } catch (oError) {
+                return false;
+            }
+        }
+
+        /**
+         * Persists display transaction code user setting in the personalization
+         *
+         * @param {boolean} bValue Whether the transaction code should be shown.
+         * @returns {Promise<undefined>} Resolves once the value was persisted.
+         *
+         * @since 1.153.0
+         * @private
+         */
+        async setDisplayTransactionCode (bValue) {
+            await UshellUserPersonalization.setItemValue("showTransactionCode", bValue);
+            this.#oEventProvider.fireEvent("displayTransactionCodeChanged");
+        }
+
+        /**
+         * Attaches an event handler to the display transaction code change event.
+         *
+         * @param {object} [oData] An object that will be passed to the handler along with the event object when the event is fired
+         * @param {function} fnFunction The handler function to call when the event occurs.
+         * This function will be called in the context of the <code>oListener</code> instance (if present) or on the event provider instance.
+         * The event object ({@link sap.ui.base.Event}) is provided as first argument of the handler. Handlers must not change the content of
+         * the event. The second argument is the specified <code>oData</code> instance (if present).
+         * @param {object} [oListener] The object that wants to be notified when the event occurs (<code>this</code> context within the
+         * handler function). If it is not specified, the handler function is called in the context of the event provider.
+         *
+         * @since 1.154.0
+         * @private
+         */
+        attachDisplayTransactionCodeChanged (...args) {
+            this.#oEventProvider.attachEvent("displayTransactionCodeChanged", ...args);
+        }
+
+        /**
+         * Detaches an event handler from the display transaction code change event.
+         *
+         * @param {function} fnFunction The handler function to detach from the event
+         * @param {object} [oListener] The object that wanted to be notified when the event occurred
+         *
+         * @since 1.154.0
+         * @private
+         */
+        detachDisplayTransactionCodeChanged (...args) {
+            this.#oEventProvider.detachEvent("displayTransactionCodeChanged", ...args);
+        }
+
+        /**
+         * Only for testing!
+         *
+         * @since 1.154.0
+         * @private
+         */
+        reset () {
+            this.#oEventProvider.destroy();
+            this.#oEventProvider = new EventProvider();
+        }
+    }
+    return new UserPersonalization();
+});

package/ui5.yaml

@@ -282,8 +282,6 @@ builder:
               - sap/ushell/components/container/ApplicationContainer.js
               - sap/ushell/components/pages/controller/PagesAndSpaceId.js
               - sap/ushell/components/SchedulingAgent/*.json                    # json files must be explicitly defined
-              - sap/ushell/components/tiles/applauncher/StaticTile.controller.js
-              - sap/ushell/components/tiles/applauncherdynamic/DynamicTile.controller.js
               - sap/ushell/components/tiles/cdm/applauncher/Component.js
               - sap/ushell/components/tiles/cdm/applauncher/StaticTile.controller.js
               - sap/ushell/components/tiles/cdm/applauncher/StaticTile.view.js
@@ -297,7 +295,7 @@ builder:
               - sap/ushell/library.js
               - sap/ushell/modules
               - sap/ushell/override.js
-              - sap/ushell/renderer/Renderer.js
+              - sap/ushell/renderer/Component.js
               - sap/ushell/renderer/RendererRootView.fragment.xml
               - sap/ushell/renderer/Shell.controller.js
               - sap/ushell/renderer/Shell.view.js
@@ -347,6 +345,7 @@ builder:
               - sap/ushell/ui5service/ShellUIService.js
               - sap/ushell/utils/HttpClient.js
               - sap/ushell/utils/utilsCdm.js
+              - sap/ushell_abap/api
               - sap/ushell_abap/bootstrap/LoadLaunchpadModule.js
               - sap/ushell_abap/adapters/abap/AppStateAdapter.js
               - sap/ushell_abap/adapters/abap/ClientSideTargetResolutionAdapter.js
@@ -362,9 +361,14 @@ builder:
               - sap/ushell_abap/adapters/abap/PersonalizationV2Adapter.js
               - sap/ushell_abap/adapters/abap/Ui5ComponentLoaderAdapter.js
               - sap/ushell_abap/adapters/abap/UserInfoAdapter.js
+              - sap/ushell_abap/adapters/abap/VisualizationInstantiationAdapter.js
+              - sap/ushell_abap/components/tiles/applauncher/StaticTile.controller.js
+              - sap/ushell_abap/components/tiles/applauncherdynamic/DynamicTile.controller.js
               - sap/ushell_abap/services/NavigationDataProvider.js
               - sap/ushell_abap/library.js
               - sap/ushell_abap/pbServices/
+              - sap/ushell_abap/ui
+              - sap/ushell_abap/utils
               - '!sap/viz/libs/sap-viz.js'
               - '!sap/ui/unified/'
             resolve: true
@@ -440,6 +444,7 @@ builder:
               - '!sap/ushell/ui/tile/'
               - '!sap/ushell/ui5service/UserStatus.js'
               - '!sap/ushell/utils/'
+              - "!sap/ushell_abap/adapters/local/"
               - '!sap/ushell_abap/bootstrap/'
               - '!sap/ushell_abap/thirdparty/sap-xhrlib-esm*.js'
               - '!sap/ushell_abap/ui5appruntime/'
@@ -514,6 +519,11 @@ builder:
           - mode: preload
             filters:
               - sap/ushell_abap/
+              - "!sap/ushell_abap/components/"
+              - sap/ushell_abap/components/TCodeNavigation/
+              - sap/ushell_abap/components/TCodeNavigation.js
+              - sap/ushell_abap/components/SideNavigation/
+              - "!sap/ushell_abap/adapters/local/"
               # Exclude all bundles
               - "!sap/ushell_abap/**/*-preload*.js"
               - "!sap/ushell_abap/preload-bundles/"
@@ -526,6 +536,14 @@ builder:
             renderer: true
       bundleOptions:
         optimize: true
+  componentPreload:
+    excludes:
+      - sap/ushell_abap/components/TCodeNavigation.js
+      - sap/ushell_abap/components/TCodeNavigation/
+    paths:
+      - sap/ushell_abap/components/tiles/applauncher/Component.js
+      - sap/ushell_abap/components/tiles/applauncherdynamic/Component.js
+      - sap/ushell_abap/components/settings/TransactionCode/Component.js
   jsdoc:
     excludes:
       - sap/ui/Device.js