@ui5/task-adaptation 1.4.2 → 1.5.0

package/eslint.config.js

@@ -1,5 +1,3 @@
-// @ts-check
-
 import * as eslintimport from "eslint-plugin-import";
 
 import eslint from "@eslint/js";
@@ -11,7 +9,11 @@ export default tseslint.config(
     {
         languageOptions: {
             parserOptions: {
-                project: true,
+                project: [
+                    "./tsconfig.json",
+                    "./test/lib/tsconfig.json",
+                    "./scripts/tsconfig.json"
+                ],
                 tsconfigRootDir: import.meta.dirname,
             },
         },
@@ -46,7 +48,21 @@ export default tseslint.config(
                 {
                     "js": "always"
                 }
+            ],
+            "@typescript-eslint/no-unused-vars": [
+                "warn", // or "error"
+                {
+                    "argsIgnorePattern": "^_",
+                    "varsIgnorePattern": "^_",
+                    "caughtErrorsIgnorePattern": "^_"
+                }
             ]
         }
+    },
+    {
+        files: ["test/**/*.spec.ts"],
+        rules: {
+            "@typescript-eslint/no-unused-expressions": "off"
+        },
     }
-);
+);

package/package.json

@@ -1,21 +1,23 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.4.2",
+    "version": "1.5.0",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
         "test": "npm run lint && npm run build && npm run coverage",
-        "lint": "npx eslint ./src",
-        "dev": "UI5_LOG_LVL=error mocha --no-timeouts --no-warnings --import=tsx --loader=esmock 'test/**/*.spec.ts'",
-        "perf": "UI5_LOG_LVL=error mocha --no-timeouts --no-warnings --import=tsx --loader=esmock 'test/**/*.perf.ts'",
-        "coverage": "npx c8 npm run dev",
+        "lint": "eslint ./src ./test/lib",
+        "dev": "UI5_LOG_LVL=error mocha --no-timeouts --no-warnings --import=tsx --loader=esmock 'test/lib/**/*.spec.ts'",
+        "perf": "UI5_LOG_LVL=error mocha --no-timeouts --no-warnings --import=tsx --loader=esmock 'test/lib/**/*.perf.ts'",
+        "integration": "UI5_LOG_LVL=error mocha --reporter-option maxDiffSize=0 --no-timeouts --no-warnings --import=tsx --loader=esmock 'test/lib/**/*.int.ts'",
+        "coverage": "c8 npm run dev",
         "preversion": "npm test",
         "version": "git-chglog --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
         "prepublishOnly": "git push --follow-tags",
         "release-note": "git-chglog -c .chglog/release-config.yml v$npm_package_version",
         "rollup": "tsx scripts/rollup.ts",
         "build": "npm run rollup && tsc -p ./",
-        "download-metadata": "tsx scripts/metadataDownloadHelper.ts"
+        "download-metadata": "tsx scripts/metadataDownloadHelper.ts",
+        "integration-setup": "scripts/test-integration-prep.sh"
     },
     "repository": {
         "type": "git",
@@ -34,25 +36,25 @@
     "license": "Apache-2.0",
     "dependencies": {
         "@sap-ux/axios-extension": "^1.16.6",
-        "@sap-ux/btp-utils": "^0.15.2",
+        "@sap-ux/btp-utils": "^1.0.2",
         "@sap-ux/store": "^0.9.1",
         "@sap-ux/system-access": "^0.5.11",
         "@sap/cf-tools": "^3.2.0",
         "@ui5/fs": "^4.0.1",
         "@ui5/logger": "^4.0.1",
         "adm-zip": "^0.5.5",
-        "axios": "^1.7.9",
+        "axios": "^1.8.3",
         "crc": "^4.3.2",
         "dotenv": "^16.0.3",
+        "filenamify": "^6.0.0",
         "jsdom": "^23.0.1",
-        "meriyah": "^6.0.3",
         "temp-dir": "^2.0.0",
+        "transliteration": "^2.3.5",
         "xml-js": "^1.6.11"
     },
     "devDependencies": {
         "@buxlabs/amd-to-es6": "^0.16.3",
-        "@istanbuljs/nyc-config-typescript": "^1.0.1",
-        "@rollup/plugin-node-resolve": "^15.2.3",
+        "@rollup/plugin-node-resolve": "^15.3.0",
         "@types/adm-zip": "^0.4.34",
         "@types/chai": "^4.2.21",
         "@types/chai-as-promised": "^7.1.4",
@@ -62,30 +64,29 @@
         "@types/mocha": "^9.1.0",
         "@types/semver": "^7.3.8",
         "@types/sinon": "^10.0.16",
+        "@ui5/builder": "^4.0.3",
         "@ui5/project": "^4.0.3",
         "amdextract": "^3.0.0",
         "builtin-modules": "^3.2.0",
-        "c8": "^9.1.0",
+        "c8": "^10.1.3",
         "chai": "^4.3.4",
         "chai-as-promised": "^7.1.1",
-        "chalk": "^4.1.2",
-        "eslint": "^8.57.0",
-        "eslint-plugin-import": "^2.29.1",
+        "eslint": "^9.22.0",
+        "eslint-plugin-import": "^2.31.0",
         "esmock": "^2.6.3",
         "glob": "^10.3.10",
         "js-yaml": "^4.1.0",
-        "lodash": "^4.17.21",
+        "meriyah": "^6.0.3",
         "minimatch": "^9.0.3",
-        "mocha": "^10.2.0",
+        "mocha": "^11.1.0",
         "mock-require": "^3.0.3",
-        "nyc": "^15.1.0",
-        "rollup": "^4.9.6",
+        "rollup": "^4.24.0",
         "semver": "^7.3.5",
         "sinon": "^18.0.1",
         "source-map-support": "^0.5.19",
         "tsx": "^4.7.1",
         "typescript": "^5.4.2",
-        "typescript-eslint": "^7.2.0"
+        "typescript-eslint": "^8.26.1"
     },
     "c8": {
         "src": "./src",
@@ -110,7 +111,8 @@
             "*/**/*.d.ts",
             "src/annotations/comparator/diffCase.ts",
             "src/annotations/transformers/transformer.ts",
-            "src/model/configuration.ts"
+            "src/model/configuration.ts",
+            "src/model/appVariantIdHierarchyItem.ts"
         ],
         "check-coverage": true,
         "statements": 85,
@@ -119,5 +121,9 @@
         "lines": 85
     },
     "types": "dist/index.d.ts",
-    "type": "module"
+    "type": "module",
+    "optionalDependencies": {
+        "@rollup/rollup-linux-x64-gnu": "^4.28.1",
+        "@rollup/rollup-linux-x64-musl": "^4.28.1"
+    }
 }

package/scripts/rollup/bundle.d.ts

@@ -1,13 +1,12 @@
 export declare const RegistrationBuild: () => void;
 
 export declare class Applier {
-    static applyChanges(manifest: any, changes: Change[], strategy: any): Promise<void>;
+    static applyChanges(manifest: any, changes: AppDescriptorChange[], strategy: any): Promise<void>;
 }
 
-export declare class Change {
+export declare class AppDescriptorChange {
     constructor(change: any);
     getLayer(): string;
-    _oDefinition: any;
 }
 
 export declare class V2MetadataConverter {

package/scripts/rollup/bundleDefinition.js

@@ -1,7 +1,7 @@
 //Flex
+import AppDescriptorChange from "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange";
 import Applier from "sap/ui/fl/apply/_internal/changes/descriptor/Applier";
 import ApplyUtil from "sap/ui/fl/apply/_internal/changes/descriptor/ApplyUtil";
-import Change from "sap/ui/fl/Change";
 import RegistrationBuild from "sap/ui/fl/apply/_internal/changes/descriptor/RegistrationBuild";
 //OData
 import URI from "sap/ui/thirdparty/URI";
@@ -10,9 +10,9 @@ import V4MetadataConverter from "sap/ui/model/odata/v4/lib/_V4MetadataConverter"
 
 export {
     //Flex
+    AppDescriptorChange,
     Applier,
     ApplyUtil,
-    Change,
     RegistrationBuild,
     //OData
     URI,

package/scripts/rollup/overrides/sap/ui/fl/Utils.js

@@ -0,0 +1,13 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+], function (
+) {
+    return {
+        getChangeFromChangesMap: function () { }
+    };
+});

package/scripts/rollup/overrides/sap/ui/fl/apply/_internal/changes/FlexCustomData.js

@@ -0,0 +1,13 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+], function (
+) {
+    return {
+        hasChangeApplyFinishedCustomData: function () { }
+    };
+});

package/scripts/rollup/overrides/sap/ui/fl/apply/_internal/flexObjects/AnnotationChange.js

@@ -0,0 +1,11 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2020 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+], function (
+) {
+    return function () {};
+}, true);

package/scripts/rollup/overrides/sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange.js

@@ -0,0 +1,68 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2020 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+], function (
+) {
+    "use strict";
+
+    /**
+     * Flexibility change class. Stores change content and related information.
+     *
+     * @param {object} oFile - File content and admin data
+     *
+     * @class sap.ui.fl.Change
+     * @private
+     * @ui5-restricted
+     * @experimental Since 1.25.0
+     */
+    var AppDescriptorChange = function (content) {
+        this.content = content;
+    };
+
+    /**
+     * Returns the change type.
+     *
+     * @returns {String} Change type of the file, for example <code>LabelChange</code>
+     * @public
+     */
+    AppDescriptorChange.prototype.getChangeType = function () {
+        return this.content?.flexObjectMetadata?.changeType || this.content?.changeType;
+    };
+
+    /**
+     * Gets the layer type for the change.
+     * @returns {string} Layer of the change file
+     *
+     * @public
+     */
+    AppDescriptorChange.prototype.getLayer = function () {
+        return this.content.layer;
+    };
+
+    /**
+     * Returns the content section of the change.
+     * @returns {string} Content of the change file. The content structure can be any JSON.
+     *
+     * @public
+     */
+    AppDescriptorChange.prototype.getContent = function () {
+        return this.content.content;
+    };
+
+    /**
+     * Returns all texts.
+     *
+     * @returns {object} All texts
+     *
+     * @function
+     */
+    AppDescriptorChange.prototype.getTexts = function () {
+        return this.content.texts;
+    };
+
+    return AppDescriptorChange;
+}, true);

package/scripts/rollup/overrides/sap/ui/fl/apply/_internal/flexObjects/VariantChange.js

@@ -0,0 +1,11 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2020 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+], function (
+) {
+    return function () {};
+}, true);

package/scripts/rollup/overrides/sap/ui/fl/apply/_internal/flexObjects/VariantManagementChange.js

@@ -0,0 +1,11 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2020 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+], function (
+) {
+    return function () {};
+}, true);

package/scripts/rollup/overrides/sap/ui/fl/apply/_internal/flexState/controlVariants/VariantManagementState.js

@@ -0,0 +1,13 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+], function (
+) {
+    return {
+        getChangeInformationProvider: function () { }
+    };
+});

package/scripts/rollup/overrides/sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerRegistration.js

@@ -0,0 +1,13 @@
+/*!
+* OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+*/
+
+sap.ui.define([
+], function (
+) {
+    return {
+        waitForChangeHandlerRegistration: function () { }
+    };
+});

package/scripts/rollup/overrides/sap/ui/fl/initial/_internal/changeHandlers/ChangeHandlerStorage.js

@@ -0,0 +1,14 @@
+/*!
+* OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+*/
+
+sap.ui.define([
+], function (
+) {
+    return {
+        getAnnotationChangeHandler: function () { },
+        getChangeHandler: function () { }
+    };
+});

package/scripts/rollup/project/ui5.yaml

@@ -6,7 +6,7 @@ metadata:
   allowSapInternal: true
 framework:
   name: SAPUI5
-  version: 1.131.0
+  version: 0.0.0
   libraries:
     - name: sap.ui.fl
     - name: sap.suite.ui.generic.template

package/scripts/test-integration-prep.sh

@@ -0,0 +1,4 @@
+for d in test/fixtures/*/ ; do
+    echo "$d"
+    npm --prefix $d i
+done

package/types/ui5.d.ts

@@ -18,6 +18,11 @@ declare class Resource {
     setString(string: string): void;
 }
 
+declare interface IWorkspace {
+    write(resource: Resource): Promise<void>;
+    byGlob(pattern: string): Promise<Resource[]>;
+}
+
 declare module "@ui5/fs/Resource" {
     export function getPath(): string;
     export function clone(): Resource;
@@ -39,6 +44,11 @@ declare module "@ui5/project/build/helpers/BuildContext" {
 
 declare module "@ui5/project/build/helpers/TaskUtil" {
     export default class TaskUtil {
+        STANDARD_TAGS: any;
+        setTag(resource: Resource, OmitFromBuildResult: any, omit: boolean);
         constructor(options: any);
     }
 }
+
+declare module "@ui5/builder/internal/taskRepository" {
+}

package/dist/cache/annotationsCacheManager.d.ts

@@ -1,8 +0,0 @@
-import CacheManager from "./cacheManager.js";
-import { IConfiguration } from "../model/types.js";
-export default class AnnotationsCacheManager extends CacheManager {
-    private tempSubFolder;
-    constructor(configuration: IConfiguration, tempSubFolder: string);
-    protected getTempId(): string;
-    getMetadataFilename(): string;
-}

package/dist/cache/annotationsCacheManager.js

@@ -1,16 +0,0 @@
-import CacheManager from "./cacheManager.js";
-export default class AnnotationsCacheManager extends CacheManager {
-    tempSubFolder;
-    constructor(configuration, tempSubFolder) {
-        super(configuration);
-        this.tempSubFolder = tempSubFolder;
-    }
-    getTempId() {
-        const { destination, appName } = this.configuration;
-        return super.normalizeId(`ui5-${destination}-${appName}-${this.tempSubFolder}`);
-    }
-    getMetadataFilename() {
-        return "annotationsmetadata.json";
-    }
-}
-//# sourceMappingURL=annotationsCacheManager.js.map

package/dist/cache/baseAppFilesCacheManager.d.ts

@@ -1,6 +0,0 @@
-import CacheManager from "./cacheManager.js";
-export default class BaseAppFilesCacheManager extends CacheManager {
-    static METADATA_FILENAME: string;
-    protected getTempId(): string;
-    getMetadataFilename(): string;
-}

package/dist/cache/baseAppFilesCacheManager.js

@@ -1,12 +0,0 @@
-import CacheManager from "./cacheManager.js";
-export default class BaseAppFilesCacheManager extends CacheManager {
-    static METADATA_FILENAME = "html5metadata.json";
-    getTempId() {
-        const { appHostId, appName, appVersion } = this.configuration;
-        return super.normalizeId(`ui5-${appHostId}-${appName}-${appVersion}`);
-    }
-    getMetadataFilename() {
-        return BaseAppFilesCacheManager.METADATA_FILENAME;
-    }
-}
-//# sourceMappingURL=baseAppFilesCacheManager.js.map

package/dist/cache/cacheManager.d.ts

@@ -1,16 +0,0 @@
-import { IConfiguration, IMetadata } from "../model/types.js";
-export default abstract class CacheManager {
-    protected configuration: IConfiguration;
-    constructor(configuration: IConfiguration);
-    protected abstract getMetadataFilename(): string;
-    protected abstract getTempId(): string;
-    protected getTempFolder(): string;
-    getFiles(fetchMetadata: () => Promise<IMetadata>, fetchFiles: () => Promise<Map<string, string>>): Promise<Map<string, string>>;
-    isMetadataSame(tempMetadata: IMetadata, metadata: IMetadata): boolean;
-    readTempMetadata(): any;
-    writeTemp(files: Map<string, string>, metadata: any): Promise<void[]>;
-    readTemp(): Promise<Map<string, string>>;
-    deleteTemp(): void;
-    protected normalizeId(id: string): string;
-    private getFilesToCache;
-}

package/dist/cache/cacheManager.js

@@ -1,65 +0,0 @@
-import * as fs from "fs";
-import * as path from "path";
-import ResourceUtil from "../util/resourceUtil.js";
-import tempFolder from "temp-dir";
-export default class CacheManager {
-    configuration;
-    constructor(configuration) {
-        this.configuration = configuration;
-    }
-    getTempFolder() {
-        return path.join(tempFolder, this.getTempId());
-    }
-    async getFiles(fetchMetadata, fetchFiles) {
-        const tempMetadata = this.readTempMetadata();
-        const metadata = await fetchMetadata();
-        if (this.isMetadataSame(tempMetadata, metadata)) {
-            return this.readTemp();
-        }
-        else {
-            const files = await fetchFiles();
-            if (files?.size > 0) {
-                await this.writeTemp(files, metadata);
-            }
-            return files;
-        }
-    }
-    isMetadataSame(tempMetadata, metadata) {
-        // TODO: Implement correct metadata comparision.
-        return tempMetadata && metadata && tempMetadata.changedOn === metadata.changedOn;
-    }
-    readTempMetadata() {
-        const tempFolder = this.getTempFolder();
-        const filename = this.getMetadataFilename();
-        const metadataPath = path.resolve(tempFolder, filename);
-        if (fs.existsSync(metadataPath)) {
-            return JSON.parse(fs.readFileSync(metadataPath, { encoding: "utf-8" }));
-        }
-    }
-    writeTemp(files, metadata) {
-        this.deleteTemp();
-        const filesToCache = this.getFilesToCache(files, metadata);
-        return ResourceUtil.write(this.getTempFolder(), filesToCache);
-    }
-    async readTemp() {
-        const files = new Map();
-        const tempFolder = this.getTempFolder();
-        if (fs.existsSync(tempFolder)) {
-            ResourceUtil.read(tempFolder, tempFolder, files, [this.getMetadataFilename()]);
-        }
-        return files;
-    }
-    deleteTemp() {
-        fs.rmSync(this.getTempFolder(), { recursive: true, force: true });
-    }
-    normalizeId(id) {
-        return id.replace(/\/\\/g, "_");
-    }
-    getFilesToCache(files, metadata) {
-        const filename = this.getMetadataFilename();
-        const filesClone = new Map([...files]);
-        filesClone.set(filename, JSON.stringify(metadata));
-        return filesClone;
-    }
-}
-//# sourceMappingURL=cacheManager.js.map

package/scripts/rollup/overrides/sap/ui/fl/Change.js

@@ -1,74 +0,0 @@
-/*!
- * OpenUI5
- * (c) Copyright 2009-2020 SAP SE or an SAP affiliate company.
- * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
- */
-
-sap.ui.define([
-
-], function (
-
-) {
-	"use strict";
-
-	/**
-	 * Flexibility change class. Stores change content and related information.
-	 *
-	 * @param {object} oFile - File content and admin data
-	 *
-	 * @class sap.ui.fl.Change
-	 * @private
-	 * @ui5-restricted
-	 * @experimental Since 1.25.0
-	 */
-	var Change = function (oFile) {
-		this._oDefinition = oFile;
-	};
-
-	/**
-	 * Returns the change type.
-	 *
-	 * @returns {String} Change type of the file, for example <code>LabelChange</code>
-	 * @public
-	 */
-	Change.prototype.getChangeType = function () {
-		if (this._oDefinition) {
-			return this._oDefinition.flexObjectMetadata
-				? this._oDefinition.flexObjectMetadata.changeType
-				: this._oDefinition.changeType
-		}
-	};
-
-	/**
-	 * Gets the layer type for the change.
-	 * @returns {string} Layer of the change file
-	 *
-	 * @public
-	 */
-	Change.prototype.getLayer = function () {
-		return this._oDefinition.layer;
-	};
-
-	/**
-	 * Returns the content section of the change.
-	 * @returns {string} Content of the change file. The content structure can be any JSON.
-	 *
-	 * @public
-	 */
-	Change.prototype.getContent = function () {
-		return this._oDefinition.content;
-	};
-
-	/**
-	 * Returns all texts.
-	 *
-	 * @returns {object} All texts
-	 *
-	 * @function
-	 */
-	Change.prototype.getTexts = function () {
-		return this._oDefinition.texts;
-	};
-
-	return Change;
-}, true);