@sapui5/sap.ushell_abap 1.152.1 → 1.154.0

package/src/main/js/sap/ushell_abap/adapters/local/ClientSideTargetResolutionAdapter.js

@@ -0,0 +1,123 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview ClientSideTargetResolutionAdapter for the local (abap) platform.
+ *
+ * Intended for OPA and standalone test scenarios.
+ *
+ * A thin subclass of the ABAP ClientSideTargetResolutionAdapter that feeds inbounds
+ * from static config JSON without requiring an OData MockServer.
+ *
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/base/util/LoaderExtensions",
+    "sap/base/util/uid",
+    "sap/ushell_abap/adapters/abap/ClientSideTargetResolutionAdapter"
+], (
+    LoaderExtensions,
+    uid,
+    AbapClientSideTargetResolutionAdapter
+) => {
+    "use strict";
+
+    /**
+     * Constructs a new local instance of the ClientSideTargetResolutionAdapter for the ABAP platform.
+     *
+     * @param {object} oSystem The system served by the adapter
+     * @param {string} sParameter Parameter string, not in use
+     * @param {object} oAdapterConfiguration Adapter configuration
+     *
+     * @class
+     * @since 1.154.0
+     * @private
+     */
+    function ClientSideTargetResolutionAdapter (oSystem, sParameter, oAdapterConfiguration) {
+        const oConfig = oAdapterConfiguration?.config || {};
+
+        // Resolving with null signals the base that no segmented start-up data will arrive
+        // (i.e. the direct-start fast-path is intentionally disabled for local/test use).
+        const pInitialSegmentPromise = Promise.resolve(null);
+
+        // Carry the full synthetic start-up payload so the base stores targetMappings and
+        // systemAliases via _storeFromFullStartupResponse before getInbounds is called.
+        const pNavTargetDataPromise = this._fetchData(oAdapterConfiguration.config).then((oTargetMappings) => {
+            return {
+                targetMappings: oTargetMappings,
+                systemAliases: oConfig.systemAliases || {},
+                urlTemplates: {}
+            };
+        });
+
+        AbapClientSideTargetResolutionAdapter.call(this, oSystem, sParameter, {
+            config: {
+                initialSegmentPromise: pInitialSegmentPromise,
+                navTargetDataPromise: pNavTargetDataPromise
+            }
+        });
+    }
+
+    ClientSideTargetResolutionAdapter.prototype = Object.create(AbapClientSideTargetResolutionAdapter.prototype);
+    ClientSideTargetResolutionAdapter.prototype.constructor = ClientSideTargetResolutionAdapter;
+
+    /**
+     * Loads target mappings from the configured JSON resource and converts them
+     * into the keyed structure expected by the base ABAP adapter.
+     *
+     * @param {object} oConfig Adapter config containing <code>targetMappingsPath</code>.
+     * @returns {Promise<Object<string, object>>} Target mappings keyed by <code>SemanticObject-action~uiadId</code>.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    ClientSideTargetResolutionAdapter.prototype._fetchData = async function (oConfig) {
+        const aTargetMappingData = oConfig.targetMappings || await LoaderExtensions.loadResource(oConfig.targetMappingsPath, { async: true });
+
+        return aTargetMappingData.reduce((oTargetMappings, oTMToAdd) => {
+            const sUiadId = oTMToAdd.uiadId || uid();
+            const sTmId = `${oTMToAdd.semanticObject}-${oTMToAdd.action}~${sUiadId}`;
+
+            if (oTargetMappings[sTmId]) {
+                throw new Error(`Conflicting tm ids '${sTmId}'`);
+            }
+
+            oTargetMappings[sTmId] = {
+                semanticObject: oTMToAdd.semanticObject,
+                semanticAction: oTMToAdd.action,
+                formFactors: {
+                    desktop: true,
+                    tablet: true,
+                    phone: true
+                },
+                signature: oTMToAdd.signature || {},
+                text: oTMToAdd.title,
+                applicationType: oTMToAdd.applicationType,
+                catalogId: oTMToAdd.catalogId,
+                tcode: oTMToAdd.tcode,
+
+                // optional
+                tmChipId: sUiadId,
+                uiadId: sUiadId,
+                isDefaultLadi: oTMToAdd.isDefaultLadi,
+                ladiHasTiles: oTMToAdd.ladiHasTiles,
+                defaultTileParams: oTMToAdd.defaultTileParams
+            };
+
+            if (oTargetMappings[sTmId].applicationType === "SAPUI5") {
+                oTargetMappings[sTmId].applicationData = `SAPUI5.Component=${oTMToAdd.ui5ComponentName}`;
+                oTargetMappings[sTmId].applicationDependencies = JSON.stringify({
+                    name: oTMToAdd.ui5ComponentName,
+                    url: new URL(sap.ui.require.toUrl(oTMToAdd.url), document.baseURI).toString(),
+                    asyncHints: {},
+                    minUi5Versions: ["1.28"]
+                });
+            } else {
+                oTargetMappings[sTmId].url = oTMToAdd.url;
+            }
+
+            return oTargetMappings;
+        }, {});
+    };
+
+    return ClientSideTargetResolutionAdapter;
+});

package/src/main/js/sap/ushell_abap/adapters/local/FlpLaunchPageAdapter.js

@@ -0,0 +1,115 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview FlpLaunchPageAdapter for the local (abap) platform.
+ *
+ * Intended for OPA and standalone test scenarios with no backend.
+ *
+ * A thin subclass of the ABAP FlpLaunchPageAdapter that feeds the compact target
+ * mappings from static config JSON instead of the <code>/sap/bc/ui2/start_up</code>
+ * backend request.
+ *
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/base/util/LoaderExtensions",
+    "sap/base/util/uid",
+    "sap/ushell_abap/adapters/abap/FlpLaunchPageAdapter"
+], (
+    LoaderExtensions,
+    uid,
+    AbapFlpLaunchPageAdapter
+) => {
+    "use strict";
+
+    /**
+     * Constructs a new local instance of the FlpLaunchPageAdapter for the ABAP platform.
+     *
+     * @param {object} oSystem The system served by the adapter
+     * @param {string} sParameter Parameter string, not in use
+     * @param {object} oAdapterConfiguration Adapter configuration.
+     *
+     * @class
+     * @since 1.154.0
+     * @private
+     */
+    function FlpLaunchPageAdapter (oSystem, sParameter, oAdapterConfiguration) {
+        // The base _readTargetMappings short-circuits to config.compactTMPromise (when present)
+        // and never issues the /sap/bc/ui2/start_up backend request that would hang here.
+        const pCompactTMs = this._fetchData(oAdapterConfiguration.config).then((oTargetMappings) => {
+            return {
+                targetMappings: oTargetMappings
+            };
+        });
+
+        AbapFlpLaunchPageAdapter.call(this, oSystem, sParameter, {
+            config: Object.assign({}, oAdapterConfiguration, {
+                compactTMPromise: pCompactTMs
+            })
+        });
+    }
+
+    FlpLaunchPageAdapter.prototype = Object.create(AbapFlpLaunchPageAdapter.prototype);
+    FlpLaunchPageAdapter.prototype.constructor = FlpLaunchPageAdapter;
+
+    /**
+     * Loads target mappings from the configured JSON resource and converts them
+     * into the keyed structure expected by the base ABAP adapter.
+     *
+     * @param {object} oConfig Adapter config containing <code>targetMappingsPath</code>.
+     * @returns {Promise<Object<string, object>>} Target mappings keyed by <code>SemanticObject-action~uiadId</code>.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    FlpLaunchPageAdapter.prototype._fetchData = async function (oConfig) {
+        const aTargetMappingData = oConfig.targetMappings || await LoaderExtensions.loadResource(oConfig.targetMappingsPath, { async: true });
+
+        return aTargetMappingData.reduce((oTargetMappings, oTMToAdd) => {
+            const sUiadId = oTMToAdd.uiadId || uid();
+            const sTmId = `${oTMToAdd.semanticObject}-${oTMToAdd.action}~${sUiadId}`;
+
+            if (oTargetMappings[sTmId]) {
+                throw new Error(`Conflicting tm ids '${sTmId}'`);
+            }
+
+            oTargetMappings[sTmId] = {
+                semanticObject: oTMToAdd.semanticObject,
+                semanticAction: oTMToAdd.action,
+                formFactors: {
+                    desktop: true,
+                    tablet: true,
+                    phone: true
+                },
+                signature: oTMToAdd.signature || {},
+                text: oTMToAdd.title,
+                applicationType: oTMToAdd.applicationType,
+                catalogId: oTMToAdd.catalogId,
+                tcode: oTMToAdd.tcode,
+
+                // optional
+                tmChipId: sUiadId,
+                uiadId: sUiadId,
+                isDefaultLadi: oTMToAdd.isDefaultLadi,
+                ladiHasTiles: oTMToAdd.ladiHasTiles,
+                defaultTileParams: oTMToAdd.defaultTileParams
+            };
+
+            if (oTargetMappings[sTmId].applicationType === "SAPUI5") {
+                oTargetMappings[sTmId].applicationData = `SAPUI5.Component=${oTMToAdd.ui5ComponentName}`;
+                oTargetMappings[sTmId].applicationDependencies = JSON.stringify({
+                    name: oTMToAdd.ui5ComponentName,
+                    url: new URL(sap.ui.require.toUrl(oTMToAdd.url), document.baseURI).toString(),
+                    asyncHints: {},
+                    minUi5Versions: ["1.28"]
+                });
+            } else {
+                oTargetMappings[sTmId].url = oTMToAdd.url;
+            }
+
+            return oTargetMappings;
+        }, {});
+    };
+
+    return FlpLaunchPageAdapter;
+});

package/src/main/js/sap/ushell_abap/adapters/local/MenuAdapter.js

@@ -0,0 +1,92 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview MenuAdapter for the local (abap) platform.
+ *
+ * Intended for OPA and standalone test scenarios.
+ *
+ * A thin subclass of the ABAP MenuAdapter that adds the metatag
+ * before calling the original adapter
+ *
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/base/util/LoaderExtensions",
+    "sap/ushell_abap/adapters/abap/MenuAdapter"
+], (
+    LoaderExtensions,
+    AbapMenuAdapter
+) => {
+    "use strict";
+
+    /**
+     * Constructs a new local instance of the MenuAdapter for the ABAP platform.
+     *
+     * @param {object} oSystem The system served by the adapter
+     * @param {string} sParameter Parameter string, not in use
+     * @param {object} oAdapterConfiguration Adapter configuration.
+     *
+     * @class
+     * @since 1.154.0
+     * @private
+     */
+    function MenuAdapter (oSystem, sParameter, oAdapterConfiguration) {
+        const oConfig = oAdapterConfiguration?.config || {};
+
+        const aData = this._fetchData(oConfig);
+        const oMetatag = document.createElement("meta");
+        oMetatag.content = JSON.stringify(aData);
+        oMetatag.setAttribute("name", "sap.ushell.assignedSpaces");
+        document.head.appendChild(oMetatag);
+
+        AbapMenuAdapter.call(this, oSystem, sParameter, {});
+    }
+
+    MenuAdapter.prototype = Object.create(AbapMenuAdapter.prototype);
+    MenuAdapter.prototype.constructor = MenuAdapter;
+
+    /**
+     * Loads spaces and pages from the configured JSON resources and assembles
+     * the space list structure expected by the base ABAP MenuAdapter.
+     *
+     * @param {object} oConfig Adapter config with <code>spacesPath</code> and <code>pagesPath</code>.
+     * @returns {object[]} Space entries including embedded page references.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    MenuAdapter.prototype._fetchData = function (oConfig) {
+        const aSpacesData = oConfig.spaces || LoaderExtensions.loadResource(oConfig.spacesPath);
+        const aPagesData = oConfig.pages || LoaderExtensions.loadResource(oConfig.pagesPath);
+
+        return aSpacesData.map((oSpaceData) => {
+            return {
+                id: oSpaceData.id || "",
+                title: oSpaceData.title || "",
+                description: oSpaceData.description || "",
+                hasWorkarea: oSpaceData.hasWorkarea || false,
+                visibility: {
+                    desktop: true,
+                    phone: true,
+                    tablet: true
+                },
+                pages: oSpaceData.pages.map((oPageReference) => {
+                    const oPageData = aPagesData.find((oPage) => oPage.id === oPageReference.id);
+                    return {
+                        type: oPageData ? "page" : "IBN",
+                        id: oPageReference.id,
+                        title: oPageData?.title || "",
+                        description: oPageData?.description || "",
+                        visibility: {
+                            desktop: true,
+                            phone: true,
+                            tablet: true
+                        }
+                    };
+                })
+            };
+        });
+    };
+
+    return MenuAdapter;
+});

package/src/main/js/sap/ushell_abap/adapters/local/PageBuildingAdapter.js

@@ -0,0 +1,242 @@
+// Copyright (c) 2009-2026 SAP SE, All Rights Reserved
+
+/**
+ * @fileOverview PageBuildingAdapter for the local (abap) platform.
+ *
+ * Intended for OPA and standalone test scenarios with no backend.
+ *
+ * @version 1.154.0
+ */
+sap.ui.define([
+    "sap/base/util/LoaderExtensions",
+    "sap/ui/core/util/MockServer",
+    "sap/ushell_abap/pbServices/ui2/Factory",
+    // Contracts need to be loaded first
+    "sap/ushell_abap/pbServices/ui2/contracts/bag",
+    "sap/ushell_abap/pbServices/ui2/contracts/configuration",
+    "sap/ushell_abap/pbServices/ui2/contracts/configurationUi",
+    "sap/ushell_abap/pbServices/ui2/contracts/fullscreen",
+    "sap/ushell_abap/pbServices/ui2/contracts/preview",
+    "sap/ushell_abap/pbServices/ui2/contracts/visible",
+    "sap/ushell_abap/pbServices/ui2/contracts/refresh",
+    "sap/ushell_abap/pbServices/ui2/contracts/search",
+    "sap/ushell_abap/pbServices/ui2/contracts/url",
+    "sap/ushell_abap/pbServices/ui2/contracts/actions",
+    "sap/ushell_abap/pbServices/ui2/contracts/types"
+], (
+    LoaderExtensions,
+    MockServer,
+    Factory
+) => {
+    "use strict";
+
+    /**
+     * Constructs a new local instance of the PageBuildingAdapter for the ABAP platform.
+     *
+     * @param {object} oSystem The system served by the adapter
+     * @param {string} sParameter Parameter string, not in use
+     * @param {object} [oAdapterConfiguration] The configuration.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    function PageBuildingAdapter (oSystem, sParameter, oAdapterConfiguration) {
+        // fetch sync to avoid race conditions
+        this._aBaseChips = oAdapterConfiguration.config.baseChips || LoaderExtensions.loadResource(oAdapterConfiguration.config.baseChipsPath);
+        this._aBaseChips.forEach((oBaseChip) => {
+            oBaseChip.chipPathAbsolute = new URL(sap.ui.require.toUrl(oBaseChip.chipPath), document.baseURI).toString();
+        });
+
+        this._aCatalogsData = oAdapterConfiguration.config.catalogs || LoaderExtensions.loadResource(oAdapterConfiguration.config.catalogsPath);
+        // patch service url to absolute
+        this._aCatalogsData.forEach((oCatalog) => {
+            oCatalog.chips.forEach((oChip) => {
+                const oTileConfiguration = oChip.configuration?.tileConfiguration;
+                if (oTileConfiguration?.service_url) {
+                    const aUrlParts = oTileConfiguration.service_url.split("?"); // query might contain non parsable UserDefault references
+                    const sAbsoluteUrl = new URL(sap.ui.require.toUrl(aUrlParts[0]), document.baseURI).toString();
+                    const sQuery = aUrlParts[1] ? `?${aUrlParts[1]}` : "";
+                    oTileConfiguration.service_url = `${sAbsoluteUrl}${sQuery}`;
+                }
+            });
+        });
+
+        const oServer = new MockServer({
+            rootUri: "/local/PageBuilding"
+        });
+        MockServer.config({
+            autoRespond: true,
+            autoRespondAfter: 0
+        });
+
+        oServer.setRequests([
+            ...this._getBaseChipRequests(),
+            ...this._getAllCatalogsRequests()
+        ]);
+        oServer.start();
+
+        this._oFactory = Factory.createFactory(
+            "/local/PageBuilding",
+            undefined,
+            "PERS",
+            undefined
+        );
+    }
+
+    /**
+     * Returns the UI2 page building factory.
+     *
+     * @returns {sap.ushell_abap.pbServices.ui2.Factory} The page building factory.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    PageBuildingAdapter.prototype.getFactory = function () {
+        return this._oFactory;
+    };
+
+    /**
+     * Builds MockServer request handlers that serve individual chip descriptors
+     * from the in-memory base chip data.
+     *
+     * @returns {object[]} MockServer request configuration objects for base chip GET requests.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    PageBuildingAdapter.prototype._getBaseChipRequests = function () {
+        return this._aBaseChips.map((oBaseChip) => {
+            return {
+                method: "GET",
+                path: new RegExp(`/Chips\\('${encodeURIComponent(`X-SAP-UI2-CHIP:${oBaseChip.id}`)}'\\).*`),
+                response: (oXhr) => {
+                    oXhr.respondJSON(200, {} /* Headers */, {
+                        d: {
+                            id: `X-SAP-UI2-CHIP:${oBaseChip.id}`,
+                            title: "",
+                            description: "",
+                            configuration: "",
+                            url: oBaseChip.chipPathAbsolute,
+                            baseChipId: `X-SAP-UI2-CHIP:${oBaseChip.id}`,
+                            catalogId: "/UI2/CATALOG_ALL",
+                            catalogPageChipInstanceId: "",
+                            referenceChipId: "",
+                            isReadOnly: "",
+                            Catalog: {},
+                            ReferenceChip: {},
+                            ChipBags: {
+                                results: []
+                            },
+                            CatalogPageChipInstance: {}
+                        }
+                    });
+                }
+            };
+        });
+    };
+
+    /**
+     * Builds a MockServer request handler that serves the <code>allCatalogs</code> OData response
+     * from the in-memory catalog data.
+     *
+     * @returns {object[]} MockServer request configuration object for the allCatalogs endpoint.
+     *
+     * @since 1.154.0
+     * @private
+     */
+    PageBuildingAdapter.prototype._getAllCatalogsRequests = function () {
+        return [{
+            method: "GET",
+            path: new RegExp("/Pages\\('.*'\\)/allCatalogs.*"),
+            response: (oXhr) => {
+                oXhr.respondJSON(200, {} /* Headers */, {
+                    d: {
+                        results: this._aCatalogsData.map((oCatalog) => {
+                            return {
+                                __metadata: {},
+                                id: `X-SAP-UI2-CATALOGPAGE:${oCatalog.id}`,
+                                type: "CATALOG_PAGE",
+                                domainId: oCatalog.id,
+                                remoteType: "",
+                                title: oCatalog.title,
+                                systemAlias: "",
+                                remoteId: "",
+                                isReadOnly: "",
+                                originalLanguage: "en",
+                                scope: "CUSTOMIZING",
+                                baseUrl: "",
+                                chipCount: oCatalog.chips.length.toString().padStart(4, "0"),
+                                outdated: "",
+                                CatalogPage: {},
+                                Chips: {
+                                    results: oCatalog.chips.map((oCatalogTile) => {
+                                        const oBaseChip = this._aBaseChips.find((oBaseChip) => oBaseChip.id === oCatalogTile.baseChipId);
+                                        if (!oBaseChip) {
+                                            throw new Error(`Missing Base Chip 'X-SAP-UI2-CHIP:${oCatalogTile.baseChipId}'`);
+                                        }
+
+                                        return {
+                                            __metadata: {},
+                                            id: `X-SAP-UI2-PAGE:X-SAP-UI2-CATALOGPAGE:${oCatalog.id}:${oCatalogTile.id}`,
+                                            catalogId: `X-SAP-UI2-CATALOGPAGE:${oCatalog.id}`,
+                                            catalogPageChipInstanceId: oCatalogTile.id,
+                                            baseChipId: `X-SAP-UI2-CHIP:${oCatalogTile.baseChipId}`,
+                                            url: oBaseChip.chipPathAbsolute,
+                                            referenceChipId: "",
+                                            isReadOnly: "",
+                                            title: "<non translatable title>",
+                                            description: "",
+                                            Catalog: {},
+                                            ReferenceChip: {},
+                                            configuration: JSON.stringify(Object.keys(oCatalogTile.configuration).reduce((oConfiguration, sConfigurationKey) => {
+                                                oConfiguration[sConfigurationKey] = JSON.stringify(oCatalogTile.configuration[sConfigurationKey]);
+                                                return oConfiguration;
+                                            }, {})),
+                                            ChipBags: {
+                                                results: Object.keys(oCatalogTile.bags).map((sBagId) => {
+                                                    const oBag = oCatalogTile.bags[sBagId];
+                                                    return {
+                                                        __metadata: {},
+                                                        chipId: `X-SAP-UI2-PAGE:X-SAP-UI2-CATALOGPAGE:${oCatalog.id}:${oCatalogTile.id}`,
+                                                        id: sBagId,
+                                                        ChipProperties: {
+                                                            results: [
+                                                                ...Object.keys(oBag.texts || {}).map((sBagTextKey) => {
+                                                                    return {
+                                                                        __metadata: {},
+                                                                        chipId: `X-SAP-UI2-PAGE:X-SAP-UI2-CATALOGPAGE:${oCatalog.id}:${oCatalogTile.id}`,
+                                                                        bagId: sBagId,
+                                                                        name: sBagTextKey,
+                                                                        value: oBag.texts[sBagTextKey],
+                                                                        translatable: "X"
+                                                                    };
+                                                                }),
+                                                                ...Object.keys(oBag.properties || {}).map((sBagPropertyKey) => {
+                                                                    return {
+                                                                        __metadata: {},
+                                                                        chipId: `X-SAP-UI2-PAGE:X-SAP-UI2-CATALOGPAGE:${oCatalog.id}:${oCatalogTile.id}`,
+                                                                        bagId: sBagId,
+                                                                        name: sBagPropertyKey,
+                                                                        value: oBag.properties[sBagPropertyKey],
+                                                                        translatable: ""
+                                                                    };
+                                                                })
+                                                            ]
+                                                        }
+                                                    };
+                                                })
+                                            },
+                                            CatalogPageChipInstance: {}
+                                        };
+                                    })
+                                }
+                            };
+                        })
+                    }
+                });
+            }
+        }];
+    };
+
+    return PageBuildingAdapter;
+});