@ui5/task-adaptation 1.6.4-rc.3 → 1.6.5-rc.1

package/CHANGELOG.md

@@ -2,7 +2,10 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.6.4-rc.3...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.6.5-rc.1...HEAD).
+
+<a name="v1.6.5-rc.1"></a>
+## [v1.6.5-rc.1] - 2026-04-13
 
 <a name="v1.6.4-rc.3"></a>
 ## [v1.6.4-rc.3] - 2026-04-07
@@ -182,6 +185,7 @@ A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task
 <a name="v1.0.0"></a>
 ## v1.0.0 - 2020-12-09
 
+[v1.6.5-rc.1]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.4-rc.3...v1.6.5-rc.1
 [v1.6.4-rc.3]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.4-rc.2...v1.6.4-rc.3
 [v1.6.4-rc.2]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.4-rc.1...v1.6.4-rc.2
 [v1.6.4-rc.1]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.3...v1.6.4-rc.1

package/README.md

@@ -27,6 +27,7 @@ For more information, see [Create an Adaptation Project](https://help.sap.com/do
 > [!NOTE]  
 > For SAP S/4HANA (on-premise) systems, a different builder is used.
 
+
 ## Branch Structure
 * `main` (npm `latest`) — The stable version, ready for production use.
 * `rc` (npm `rc`) — Active development. The code here may be unstable and features are subject to change. Use at your own risk.

package/dist/adapters/abapAdapter.d.ts

@@ -2,10 +2,10 @@ import { IAdapter } from "./adapter.js";
 import { AdaptCommandChain, MergeCommandChain, PostCommandChain } from "./commands/command.js";
 import BaseApp from "../baseAppManager.js";
 import AppVariant from "../appVariantManager.js";
-import AnnotationManager from "../annotations/annotationManager.js";
+import IAnnotationManager from "../annotations/annotationManager.js";
 export default class AbapAdapter implements IAdapter {
     private annotationManager;
-    constructor(annotationManager: AnnotationManager);
+    constructor(annotationManager: IAnnotationManager);
     createAdaptCommandChain(baseApp: BaseApp, appVariant: AppVariant): AdaptCommandChain;
     createMergeCommandChain(baseApp: BaseApp, appVariant: AppVariant): MergeCommandChain;
     createPostCommandChain(): PostCommandChain;

package/dist/annotations/cfAnnotationManager.d.ts

@@ -0,0 +1,4 @@
+import IAnnotationManager from "./annotationManager.js";
+export default class CFAnnotationManager implements IAnnotationManager {
+    process(_baseAppManifest: any, _appVariantId: string, _prefix: string): Promise<Map<string, string>>;
+}

package/dist/annotations/cfAnnotationManager.js

@@ -0,0 +1,7 @@
+export default class CFAnnotationManager {
+    async process(_baseAppManifest, _appVariantId, _prefix) {
+        // No annotation processing needed for cf
+        return new Map();
+    }
+}
+//# sourceMappingURL=cfAnnotationManager.js.map

package/dist/bundle.js

@@ -2788,9 +2788,9 @@ const PROPERTIES_PATTERNS = {
 const SUPPORTED_TYPES = {
   uri: "string",
   type: "string",
-  settings: typeof ({}),
+  settings: "object",
   dataSourceCustom: "boolean",
-  annotations: typeof []
+  annotations: "array"
 };
 function isDataSourceIdExistingInManifest(oManifestDataSources, sDataSourceId) {
   return Object.keys(oManifestDataSources).includes(sDataSourceId);
@@ -2813,7 +2813,7 @@ function checksWhenAddingTwoDataSources(oManifestDataSources, oChangeDataSource)
   const sDataSourceOfTypeOData = getDataSourceNameByType(oChangeDataSource, "OData");
   const sDataSourceOfTypeODataAnnotation = getDataSourceNameByType(oChangeDataSource, "ODataAnnotation");
   if (!(sDataSourceOfTypeOData && sDataSourceOfTypeODataAnnotation)) {
-    throw new Error("When adding two data sources it is only allwoed to add a data source with type 'OData' and the other one must be of type 'ODataAnnotation'.");
+    throw new Error("When adding two data sources it is only allowed to add a data source with type 'OData' and the other one must be of type 'ODataAnnotation'.");
   }
   if (!oChangeDataSource[sDataSourceOfTypeOData]?.settings?.annotations?.includes(sDataSourceOfTypeODataAnnotation)) {
     throw new Error(`Data source '${sDataSourceOfTypeOData}' does not include annotation '${sDataSourceOfTypeODataAnnotation}' under 'settings/annotations' array.`);
@@ -2824,9 +2824,9 @@ function checksWhenAddingTwoDataSources(oManifestDataSources, oChangeDataSource)
   checkDefinedAnnotationsExistInManifest(oManifestDataSources, sDataSourceOfTypeOData, aToBeCheckedInManifestAnnotations);
 }
 function checksWhenAddingOneDataSource(oManifestDataSources, oChangeDataSource) {
-  const sDataSourceOfTypeOData = getDataSourceNameByType(oChangeDataSource, "OData");
-  if (oChangeDataSource[sDataSourceOfTypeOData].settings?.annotations) {
-    checkDefinedAnnotationsExistInManifest(oManifestDataSources, sDataSourceOfTypeOData, oChangeDataSource[sDataSourceOfTypeOData].settings.annotations);
+  const [sDataSourceName, oDataSource] = Object.entries(oChangeDataSource)[0];
+  if (oDataSource.settings?.annotations) {
+    checkDefinedAnnotationsExistInManifest(oManifestDataSources, sDataSourceName, oDataSource.settings.annotations);
   }
 }
 function postChecks(oManifestDataSources, oChangeDataSource, aDataSources) {

package/dist/landscapeConfiguration.js

@@ -7,6 +7,7 @@ import LocalRepository from "./repositories/localRepository.js";
 import AbapAnnotationManager from "./annotations/abapAnnotationManager.js";
 import LocalAnnotationManager from "./annotations/localAnnotationManager.js";
 import { validateObject } from "./util/commonUtil.js";
+import CFAnnotationManager from "./annotations/cfAnnotationManager.js";
 export function initialize(configuration) {
     validateObject(configuration, ["type"], "should be specified in ui5.yaml configuration: 'cf' or 'abap'");
     const repository = getRepository(configuration);
@@ -51,7 +52,7 @@ function getAnnotationManager(configuration, repository) {
         case "abap":
             return new AbapAnnotationManager(configuration, repository);
         case "cf":
-            return new LocalAnnotationManager();
+            return new CFAnnotationManager();
         default:
             throw new Error(`No annotation manager found for the given configuration type '${configuration.type}'`);
     }

package/dist/previewManager.js

@@ -55,11 +55,14 @@ export default class PreviewManager {
         });
     }
     async processPreviewResources(baseAppFiles) {
+        if (!PreviewManager.isPreviewRequested()) {
+            log.verbose("Preview mode not requested, skipping downloading reuse libraries and xs-app.json processing.");
+            return;
+        }
         log.verbose(`Downloading reuse libraries to reuse folder`);
         const xsAppFiles = new Array();
         if (this.fetchLibsPromises.size === 0) {
             log.verbose("No reuse libraries defined in ui5AppInfo.json for preview");
-            return;
         }
         const mergedFiles = new Map();
         for (const [libName, libFilesPromise] of this.fetchLibsPromises) {
@@ -81,6 +84,9 @@ export default class PreviewManager {
             xsAppJson = await fetchCredentialsAndEnhanceRoutes(xsAppJson, this.configuration);
             mergedFiles.set(XS_APP_JSON_FILE, xsAppJson);
         }
+        if (mergedFiles.size === 0) {
+            return;
+        }
         await ResourceUtil.writeInProject(REUSE_DIR, mergedFiles);
     }
     preReadLibs(reuseLibs, repository) {

package/dist/repositories/localRepository.js

@@ -57,10 +57,11 @@ export default class LocalRepository {
         return FsUtil.readFilesRecursively(cachebusterToken);
     }
     getLocalFilesDirectory(appId) {
-        const baseDir = this.configuration.adpDir
-            ? path.normalize(this.configuration.adpDir).replace(/\\/g, "/").replace(/\/+$/, "").split("/")
+        const adpDirConfigured = process.env.ADP_BUILDER_DIR || this.configuration.adpDir;
+        const adpDir = adpDirConfigured
+            ? path.normalize(adpDirConfigured).replace(/\\/g, "/").replace(/\/+$/, "").split("/")
             : [".."];
-        return path.join(process.cwd(), ...baseDir, appId);
+        return path.join(process.cwd(), ...adpDir, appId);
     }
 }
 //# sourceMappingURL=localRepository.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.6.4-rc.3",
+    "version": "1.6.5-rc.1",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
@@ -84,8 +84,8 @@
         "sinon": "^18.0.1",
         "source-map-support": "^0.5.19",
         "tsx": "^4.21.0",
-        "typescript": "^5.9.3",
-        "typescript-eslint": "^8.48.1",
+        "typescript": "^6.0.2",
+        "typescript-eslint": "^8.58.0",
         "yargs": "^17.7.2"
     },
     "c8": {
@@ -97,18 +97,13 @@
             "text-summary"
         ],
         "exclude": [
-            ".eslintrc.js",
-            "docs/**",
-            "jsdocs/**",
             "coverage/**",
             "test/**",
-            "lib/processors/jsdoc/lib/**",
             "dist/**",
             "src/model/types.ts",
             "src/util/requestUtil.ts",
             "src/util/renamingHandlers/renamingHandler.ts",
             "scripts/**/*.js",
-            "scripts/git/octokitUtil.ts",
             "*/**/*.d.ts",
             "src/annotations/comparator/diffCase.ts",
             "src/annotations/transformers/transformer.ts",
@@ -117,8 +112,7 @@
             "src/adapters/adapter.ts",
             "src/adapters/previewAdapter.ts",
             "src/repositories/repository.ts",
-            "src/annotations/annotationManager.ts",
-            "src/processors/processor.ts"
+            "src/annotations/annotationManager.ts"
         ],
         "check-coverage": true,
         "statements": 85,

package/rollup/overrides/sap/ui/fl/apply/_internal/changes/descriptor/app/AddNewDataSource.js

@@ -0,0 +1,157 @@
+/*!
+ * ${copyright}
+ */
+
+sap.ui.define([
+	"sap/ui/fl/util/DescriptorChangeCheck"
+], function(
+	DescriptorChangeCheck
+) {
+	"use strict";
+
+	const MANDATORY_PROPERTIES = ["uri"];
+	const SUPPORTED_PROPERTIES = [...MANDATORY_PROPERTIES, "type", "settings", "customType"];
+	const PROPERTIES_PATTERNS = {
+		type: "^(OData|ODataAnnotation|INA|XML|JSON|FHIR|WebSocket|http)$",
+		customType: "^false$"
+	};
+	const SUPPORTED_TYPES = {
+		uri: "string",
+		type: "string",
+		settings: "object",
+		dataSourceCustom: "boolean",
+		annotations: "array"
+	};
+
+	function isDataSourceIdExistingInManifest(oManifestDataSources, sDataSourceId) {
+		return Object.keys(oManifestDataSources).includes(sDataSourceId);
+	}
+
+	function getDataSourceType(oDataSource) {
+		return oDataSource.type || "OData";
+	}
+
+	function getDataSourceNameByType(oChangeDataSource, sType) {
+		const [sDataSourceName] = Object.entries(oChangeDataSource).find(([, oDataSource]) => getDataSourceType(oDataSource) === sType) || [];
+		return sDataSourceName;
+	}
+
+	function checkDefinedAnnotationsExistInManifest(oManifestDataSources, sDataSourceOfTypeOData, aToBeCheckedInManifestAnnotations) {
+		aToBeCheckedInManifestAnnotations.forEach(function(sAnnotation) {
+			if (!isDataSourceIdExistingInManifest(oManifestDataSources, sAnnotation)) {
+				throw new Error(`Referenced annotation '${sAnnotation}' in the annotation array of data source '${sDataSourceOfTypeOData}' does not exist in the manifest.`);
+			}
+		});
+	}
+
+	function checksWhenAddingTwoDataSources(oManifestDataSources, oChangeDataSource) {
+		const sDataSourceOfTypeOData = getDataSourceNameByType(oChangeDataSource, "OData");
+		const sDataSourceOfTypeODataAnnotation = getDataSourceNameByType(oChangeDataSource, "ODataAnnotation");
+
+		if (!(sDataSourceOfTypeOData && sDataSourceOfTypeODataAnnotation)) {
+			throw new Error("When adding two data sources it is only allowed to add a data source with type 'OData' and the other one must be of type 'ODataAnnotation'.");
+		}
+
+		if (!oChangeDataSource[sDataSourceOfTypeOData]?.settings?.annotations?.includes(sDataSourceOfTypeODataAnnotation)) {
+			throw new Error(`Data source '${sDataSourceOfTypeOData}' does not include annotation '${sDataSourceOfTypeODataAnnotation}' under 'settings/annotations' array.`);
+		}
+
+		const aToBeCheckedInManifestAnnotations = oChangeDataSource[sDataSourceOfTypeOData].settings.annotations.filter(function(sAnnotation) {
+			return sAnnotation !== sDataSourceOfTypeODataAnnotation;
+		});
+		checkDefinedAnnotationsExistInManifest(oManifestDataSources, sDataSourceOfTypeOData, aToBeCheckedInManifestAnnotations);
+	}
+
+	function checksWhenAddingOneDataSource(oManifestDataSources, oChangeDataSource) {
+		const [sDataSourceName, oDataSource] = Object.entries(oChangeDataSource)[0];
+		if (oDataSource.settings?.annotations) {
+			checkDefinedAnnotationsExistInManifest(oManifestDataSources, sDataSourceName, oDataSource.settings.annotations);
+		}
+	}
+
+	function postChecks(oManifestDataSources, oChangeDataSource, aDataSources) {
+		aDataSources.forEach(function(sDataSource) {
+			if (isDataSourceIdExistingInManifest(oManifestDataSources, sDataSource)) {
+				throw new Error(`There is already a dataSource '${sDataSource}' existing in the manifest.`);
+			}
+
+			checkIfAnnotationsPropertyIsAnArray(oChangeDataSource, sDataSource);
+		});
+		if (aDataSources.length === 1) {
+			checksWhenAddingOneDataSource(oManifestDataSources, oChangeDataSource);
+		}
+		if (aDataSources.length === 2) {
+			checksWhenAddingTwoDataSources(oManifestDataSources, oChangeDataSource);
+		}
+	}
+
+	function checkIfAnnotationsPropertyIsAnArray(oChangeDataSource, sDataSource) {
+		const sDataSourceType = getDataSourceType(oChangeDataSource[sDataSource]);
+
+		if (oChangeDataSource[sDataSource].settings?.annotations) {
+			if (sDataSourceType !== "OData") {
+				throw new Error(`Data source '${sDataSource}' which is of type '${sDataSourceType}' contains the annotations array. Only data sources with type 'OData' could contain the 'settings/annotations' array.`);
+			}
+
+			if (!Array.isArray(oChangeDataSource[sDataSource].settings.annotations)) {
+				throw new Error("Property 'annotations' must be of type 'array'.");
+			}
+		}
+	}
+
+	/**
+	 * Descriptor change merger for change type <code>appdescr_app_addNewDataSource</code>.
+	 * Adds a new data source to the manifest.json file under the path sap.app.dataSources.
+	 *
+	 * Available only for build {@link sap.ui.fl.apply._internal.changes.descriptor.RegistrationBuild}.
+	 *
+	 * @namespace
+	 * @alias sap.ui.fl.apply._internal.changes.descriptor.app.AddNewDataSource
+	 * @since 1.87
+	 * @version ${version}
+	 * @private
+	 * @ui5-restricted sap.ui.fl.apply._internal
+	 */
+	const AddNewDataSource = {
+
+		/**
+		 * Applies the <code>appdescr_app_addNewDataSource</code> change to the manifest.
+		 *
+		 * @param {object} oManifest - Original manifest
+		 * @param {sap.ui.fl.apply._internal.flexObjects.AppDescriptorChange} oChange - Change with type <code>appdescr_app_addNewDataSource</code>
+		 * @param {object} oChange.content - Details of the change
+		 * @param {object} oChange.content.dataSource - Data source of <code>sap.app/dataSource</code> that is being changed
+		 * @returns {object} Updated manifest with changed <code>sap.app/dataSource</code>
+		 *
+		 * @private
+		 * @ui5-restricted sap.ui.fl.apply._internal
+		 */
+		applyChange(oManifest, oChange) {
+			oManifest["sap.app"].dataSources ||= {};
+			const oChangeContent = oChange.getContent();
+
+			const aDataSources = DescriptorChangeCheck.getAndCheckContentObject(oChangeContent, {
+				sKey: "dataSource",
+				sChangeType: oChange.getChangeType(),
+				iMaxNumberOfKeys: 2,
+				aMandatoryProperties: MANDATORY_PROPERTIES,
+				aSupportedProperties: SUPPORTED_PROPERTIES,
+				oSupportedPropertyPattern: PROPERTIES_PATTERNS,
+				oSupportedPropertyTypes: SUPPORTED_TYPES
+			});
+
+			aDataSources.forEach(function(sDataSource) {
+				DescriptorChangeCheck.checkIdNamespaceCompliance(sDataSource, oChange);
+			});
+
+			postChecks(oManifest["sap.app"].dataSources, oChangeContent.dataSource, aDataSources);
+
+			Object.assign(oManifest["sap.app"].dataSources, oChangeContent.dataSource);
+
+			return oManifest;
+		}
+
+	};
+
+	return AddNewDataSource;
+});