@sap-ux/adp-tooling 1.0.29 → 1.0.30

package/dist/writer/inbound-navigation.d.ts

@@ -7,9 +7,13 @@ import type { InternalInboundNavigation, DescriptorVariantContent } from '../typ
  * @param basePath - The base path of the project.
  * @param configs - The inbound configuration properties.
  * @param fs - Optional mem-fs editor instance.
+ * @param systemUI5Version - Optional UI5 version string from the system (e.g. '1.142.0').
+ *   When the version is 1.142 or lower and the project is not a CF project, legacy change types are used.
+ * @param isCfProject - Whether this is a Cloud Foundry adaptation project. CF projects always use
+ *   the new 'appdescr_app_setInbounds' change type regardless of UI5 version.
  * @returns The mem-fs editor instance.
  */
-export declare function generateInboundConfig(basePath: string, configs: InternalInboundNavigation[], fs?: Editor): Promise<Editor>;
+export declare function generateInboundConfig(basePath: string, configs: InternalInboundNavigation[], fs?: Editor, systemUI5Version?: string, isCfProject?: boolean): Promise<Editor>;
 /**
  * Generates i18n entries for FLP configuration based on the provided configuration and application ID.
  *

package/dist/writer/inbound-navigation.js

@@ -3,16 +3,20 @@ import { create as createStorage } from 'mem-fs';
 import { create } from 'mem-fs-editor';
 import { SapShortTextType, removeAndCreateI18nEntries } from '@sap-ux/i18n';
 import { getVariant, updateVariant } from '../index.js';
-import { enhanceManifestChangeContentWithFlpConfig as enhanceInboundConfig } from './options.js';
+import { enhanceManifestChangeContentWithFlpConfig as enhanceInboundConfig, shouldUseLegacyInboundChangeTypes } from './options.js';
 /**
  * Generates and writes the inbound configuration to the manifest.appdescr_variant file.
  *
  * @param basePath - The base path of the project.
  * @param configs - The inbound configuration properties.
  * @param fs - Optional mem-fs editor instance.
+ * @param systemUI5Version - Optional UI5 version string from the system (e.g. '1.142.0').
+ *   When the version is 1.142 or lower and the project is not a CF project, legacy change types are used.
+ * @param isCfProject - Whether this is a Cloud Foundry adaptation project. CF projects always use
+ *   the new 'appdescr_app_setInbounds' change type regardless of UI5 version.
  * @returns The mem-fs editor instance.
  */
-export async function generateInboundConfig(basePath, configs, fs) {
+export async function generateInboundConfig(basePath, configs, fs, systemUI5Version, isCfProject = false) {
     if (!fs) {
         fs = create(createStorage());
     }
@@ -24,7 +28,8 @@ export async function generateInboundConfig(basePath, configs, fs) {
             config.inboundId = `${variant.id}.InboundID`;
         }
     }
-    enhanceInboundConfig(configs, variant.id, variant.content);
+    const useLegacyChangeTypes = shouldUseLegacyInboundChangeTypes(systemUI5Version, isCfProject);
+    enhanceInboundConfig(configs, variant.id, variant.content, useLegacyChangeTypes);
     await updateVariant(basePath, variant, fs);
     await updateI18n(basePath, variant.id, configs, fs);
     return fs;

package/dist/writer/options.d.ts

@@ -53,14 +53,28 @@ export declare function hasDeployConfig(config: AdpWriterConfig): config is AdpW
  * @param config full project configuration
  */
 export declare function enhanceUI5DeployYaml(ui5Config: UI5Config, config: AdpWriterConfigWithDeploy): void;
+/**
+ * Determines whether the legacy inbound change types should be used based on the system UI5 version.
+ * Legacy change types ('appdescr_app_addNewInbound' + 'appdescr_app_removeAllInboundsExceptOne') are
+ * used for ABAP systems on UI5 1.142 or lower. CF projects always use the new type regardless of version.
+ * When the version cannot be determined on an ABAP system, legacy change types are used as a safe default
+ * since systems too old to expose a version service are almost certainly too old for 'appdescr_app_setInbounds'.
+ *
+ * @param systemUI5Version - The UI5 version string reported by the system (e.g. '1.142.0').
+ * @param isCfProject - Whether this is a Cloud Foundry adaptation project.
+ * @returns True when the legacy change types must be used.
+ */
+export declare function shouldUseLegacyInboundChangeTypes(systemUI5Version: string | undefined, isCfProject: boolean): boolean;
 /**
  * Generate Inbound change content required for manifest.appdescriptor.
  *
  * @param flpConfigurations FLP cloud project configuration
  * @param appId Application variant id
  * @param manifestChangeContent Application variant change content
+ * @param useLegacyChangeTypes When true, use legacy 'appdescr_app_addNewInbound' +
+ *   'appdescr_app_removeAllInboundsExceptOne' change types instead of 'appdescr_app_setInbounds'.
  */
-export declare function enhanceManifestChangeContentWithFlpConfig(flpConfigurations: InternalInboundNavigation[], appId: string, manifestChangeContent?: Content[]): void;
+export declare function enhanceManifestChangeContentWithFlpConfig(flpConfigurations: InternalInboundNavigation[], appId: string, manifestChangeContent?: Content[], useLegacyChangeTypes?: boolean): void;
 /**
  * Generate custom configuration required for the ui5.yaml.
  *

package/dist/writer/options.js

@@ -1,6 +1,13 @@
 import { UI5_CDN_URL } from '../base/constants/index.js';
 import { AdaptationProjectType } from '@sap-ux/axios-extension';
 import { SupportedProject } from '../source/index.js';
+import { isFeatureSupportedVersion } from '../ui5/format.js';
+/**
+ * ABAP added support for 'appdescr_app_setInbounds' in UI5 1.143. On older systems we must fall back
+ * to the legacy 'appdescr_app_addNewInbound' + 'appdescr_app_removeAllInboundsExceptOne' pair.
+ * CF projects always use the new type.
+ */
+const MIN_VERSION_FOR_SET_INBOUNDS = '1.143.0';
 const VSCODE_URL = 'https://REQUIRED_FOR_VSCODE.example';
 /**
  * Generate the configuration for the middlewares required for the ui5.yaml.
@@ -261,24 +268,91 @@ function getInboundChangeContentWithNewInboundID(flpConfiguration, appId) {
     }
     return content;
 }
+/**
+ * Determines whether the legacy inbound change types should be used based on the system UI5 version.
+ * Legacy change types ('appdescr_app_addNewInbound' + 'appdescr_app_removeAllInboundsExceptOne') are
+ * used for ABAP systems on UI5 1.142 or lower. CF projects always use the new type regardless of version.
+ * When the version cannot be determined on an ABAP system, legacy change types are used as a safe default
+ * since systems too old to expose a version service are almost certainly too old for 'appdescr_app_setInbounds'.
+ *
+ * @param systemUI5Version - The UI5 version string reported by the system (e.g. '1.142.0').
+ * @param isCfProject - Whether this is a Cloud Foundry adaptation project.
+ * @returns True when the legacy change types must be used.
+ */
+export function shouldUseLegacyInboundChangeTypes(systemUI5Version, isCfProject) {
+    if (isCfProject) {
+        return false;
+    }
+    if (!systemUI5Version) {
+        return true;
+    }
+    return !isFeatureSupportedVersion(MIN_VERSION_FOR_SET_INBOUNDS, systemUI5Version);
+}
+/**
+ * Appends legacy inbound change entries ('appdescr_app_addNewInbound' +
+ * 'appdescr_app_removeAllInboundsExceptOne') for a single FLP configuration.
+ *
+ * @param flpConfig - The inbound configuration to write.
+ * @param appId - Application variant id.
+ * @param manifestChangeContent - Target array to push changes into.
+ * @param isFirst - Whether this is the first inbound in the list (controls removeAllInboundsExceptOne).
+ */
+function appendLegacyInboundChanges(flpConfig, appId, manifestChangeContent, isFirst) {
+    const inboundChangeContent = getInboundChangeContentWithNewInboundID(flpConfig, appId);
+    manifestChangeContent.push({
+        changeType: 'appdescr_app_addNewInbound',
+        content: {
+            inbound: {
+                [flpConfig.inboundId]: inboundChangeContent.inbounds[flpConfig.inboundId]
+            }
+        },
+        texts: {
+            'i18n': 'i18n/i18n.properties'
+        }
+    });
+    // Only emit 'removeAllInboundsExceptOne' after the first inbound is added.
+    // This change type wipes any inbounds inherited from the base app, keeping only
+    // the one just added. Subsequent inbounds in this loop are then stacked on top
+    // via additional 'appdescr_app_addNewInbound' entries. Emitting it later would
+    // race with the merge on the ABAP side.
+    if (isFirst) {
+        manifestChangeContent.push({
+            changeType: 'appdescr_app_removeAllInboundsExceptOne',
+            content: { inboundId: flpConfig.inboundId },
+            texts: {}
+        });
+    }
+}
+/**
+ * Appends a single 'appdescr_app_setInbounds' change entry for a single FLP configuration.
+ *
+ * @param flpConfig - The inbound configuration to write.
+ * @param appId - Application variant id.
+ * @param manifestChangeContent - Target array to push changes into.
+ */
+function appendSetInboundsChange(flpConfig, appId, manifestChangeContent) {
+    const inboundChangeContent = getInboundChangeContentWithNewInboundID(flpConfig, appId);
+    manifestChangeContent.push({
+        changeType: 'appdescr_app_setInbounds',
+        content: inboundChangeContent,
+        texts: {
+            'i18n': 'i18n/i18n.properties'
+        }
+    });
+}
 /**
  * Generate Inbound change content required for manifest.appdescriptor.
  *
  * @param flpConfigurations FLP cloud project configuration
  * @param appId Application variant id
  * @param manifestChangeContent Application variant change content
+ * @param useLegacyChangeTypes When true, use legacy 'appdescr_app_addNewInbound' +
+ *   'appdescr_app_removeAllInboundsExceptOne' change types instead of 'appdescr_app_setInbounds'.
  */
-export function enhanceManifestChangeContentWithFlpConfig(flpConfigurations, appId, manifestChangeContent = []) {
-    flpConfigurations.forEach((flpConfig) => {
-        const inboundChangeContent = getInboundChangeContentWithNewInboundID(flpConfig, appId);
-        const addInboundChange = {
-            changeType: 'appdescr_app_setInbounds',
-            content: inboundChangeContent,
-            texts: {
-                'i18n': 'i18n/i18n.properties'
-            }
-        };
-        manifestChangeContent.push(addInboundChange);
+export function enhanceManifestChangeContentWithFlpConfig(flpConfigurations, appId, manifestChangeContent = [], useLegacyChangeTypes = false) {
+    const append = useLegacyChangeTypes ? appendLegacyInboundChanges : appendSetInboundsChange;
+    flpConfigurations.forEach((flpConfig, index) => {
+        append(flpConfig, appId, manifestChangeContent, index === 0);
     });
 }
 /**

package/package.json

@@ -10,7 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
   },
-  "version": "1.0.29",
+  "version": "1.0.30",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",