@ui5/task-adaptation 1.5.1 → 1.5.2-rc.0

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.5.1...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.5.2-rc.0...HEAD).
+
+<a name="v1.5.2-rc.0"></a>
+## [v1.5.2-rc.0] - 2025-08-19
 
 <a name="v1.5.1"></a>
 ## [v1.5.1] - 2025-08-06
@@ -119,6 +122,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.5.2-rc.0]: https://github.com/SAP/ui5-task-adaptation/compare/v1.5.1...v1.5.2-rc.0
 [v1.5.1]: https://github.com/SAP/ui5-task-adaptation/compare/v1.4.3...v1.5.1
 [v1.4.3]: https://github.com/SAP/ui5-task-adaptation/compare/v1.4.2...v1.4.3
 [v1.4.2]: https://github.com/SAP/ui5-task-adaptation/compare/v1.4.0...v1.4.2

package/dist/annotationManager.d.ts

@@ -10,8 +10,7 @@ export default class AnnotationManager {
     private configuration;
     constructor(configuration: IConfiguration, abapRepoManager: AbapRepoManager);
     ANNOTATIONS_FOLDER: string;
-    process(renamedBaseAppManifest: any, languages: Language[]): Promise<Map<string, string>>;
-    private normalizeAppVariantId;
+    process(baseAppManifest: any, languages: Language[], appVariantId: string, prefix: string): Promise<Map<string, string>>;
     private updateManifestModel;
     private createManifestModel;
     private enhanceManifestModel;

package/dist/annotationManager.js

@@ -13,31 +13,26 @@ export default class AnnotationManager {
         this.abapRepoManager = abapRepoManager;
     }
     ANNOTATIONS_FOLDER = "annotations";
-    async process(renamedBaseAppManifest, languages) {
-        const { id } = renamedBaseAppManifest["sap.app"];
-        const normalisedId = this.normalizeAppVariantId(id);
+    async process(baseAppManifest, languages, appVariantId, prefix) {
         //TODO: switch to this after resolving @i18n custom model
         const modelName = I18N_DEFAULT_MODEL_NAME; //`i18n_a9n_${normalisedId}`;
-        const i18nPathName = path.join(I18N_DEFAULT_PATH, normalisedId);
-        const i18nManager = new I18nManager(modelName, id, languages);
+        const i18nPathName = path.join(prefix, I18N_DEFAULT_PATH);
+        const i18nManager = new I18nManager(modelName, appVariantId, languages);
         const serviceRequestor = new ServiceRequestor(this.configuration, this.abapRepoManager);
         const dataSourceManager = new DataSourceManager();
-        dataSourceManager.addDataSources(renamedBaseAppManifest["sap.app"]?.dataSources);
+        dataSourceManager.addDataSources(baseAppManifest["sap.app"]?.dataSources);
         const annotationFiles = await dataSourceManager.createAnnotationFiles(languages, i18nManager, serviceRequestor);
         const i18nFiles = i18nManager.createFiles(i18nPathName);
         if (i18nManager.hasTranslations()) {
-            this.updateManifestModel(renamedBaseAppManifest, modelName, i18nPathName);
+            this.updateManifestModel(baseAppManifest, modelName, i18nPathName);
         }
         return new Map([...annotationFiles, ...i18nFiles]);
     }
-    normalizeAppVariantId(id, replaceWith = "") {
-        return id.replace(/[.\W]+/gi, replaceWith);
-    }
-    updateManifestModel(renamedBaseAppManifest, modelName, i18nPathName) {
+    updateManifestModel(baseAppManifest, modelName, i18nPathName) {
         const uri = `${i18nPathName}/i18n.properties`;
-        this.enhanceManifestModel(renamedBaseAppManifest, modelName, uri);
+        this.enhanceManifestModel(baseAppManifest, modelName, uri);
         //TODO: switch to this after resolving @i18n custom model
-        //this.createManifestModel(renamedBaseAppManifest, modelName, uri);
+        //this.createManifestModel(baseAppManifest, modelName, uri);
     }
     createManifestModel(manifest, modelName, uri) {
         let sapui5 = manifest[SAPUI5] == null ? manifest[SAPUI5] = {} : manifest[SAPUI5];

package/dist/appVariantManager.d.ts

@@ -7,13 +7,26 @@ export default class AppVariant {
     readonly reference: string;
     readonly layer: any;
     readonly content: any;
+    prefix: string;
+    private movedFiles;
+    private renaming;
     static fromWorkspace(workspace: IWorkspace, projectNamespace: string): Promise<AppVariant>;
     static fromFiles(files: ReadonlyMap<string, string>): AppVariant;
     private constructor();
-    getProcessedFiles(): Map<string, string>;
+    getProcessedFiles(): ReadonlyMap<string, string>;
+    /**
+     * Since we moved files, we need to update paths where they were referenced.
+     * To do this we use renameMap function along with renaming ids.
+     */
+    getRenamingForMovedFiles(): Map<string, string>;
     getProcessedManifestChanges(): IChange[];
     private validateManifest;
     private updateRelativePaths;
-    private isManifestChange;
+    /**
+     * 3p. We not only omit files, which were moved or deleted from the resulted
+     * file set, but also update existing adaptation project resources with
+     * renamed content, otherwise flexibility-bundle will contain not renamed
+     * content of files.
+     */
     omitDeletedResources(files: ReadonlyMap<string, string>, projectNamespace: string, taskUtil: TaskUtil): void;
 }

package/dist/appVariantManager.js

@@ -1,9 +1,9 @@
+import { dotToUnderscore, isManifestChange } from "./util/commonUtil.js";
+import FilesUtil from "./util/filesUtil.js";
 import ResourceUtil from "./util/resourceUtil.js";
 import { posix as path } from "path";
-import { rename } from "./util/commonUtil.js";
-const CHANGES_DIR = "changes/";
+import { moveFile, moveFiles } from "./util/movingHandler/fileMoveHandler.js";
 const CHANGES_EXT = ".change";
-const MANIFEST_CHANGE = "appdescr_";
 export default class AppVariant {
     files;
     resources;
@@ -11,6 +11,9 @@ export default class AppVariant {
     reference;
     layer;
     content;
+    prefix = "";
+    movedFiles = new Map();
+    renaming = new Map();
     static async fromWorkspace(workspace, projectNamespace) {
         const EXTENSIONS_TO_PROCESS = "js,json,xml,html,properties,change,appdescr_variant,ctrl_variant,ctrl_variant_change,ctrl_variant_management_change,variant,fioriversion,codeChange,xmlViewChange,context";
         const resources = await workspace.byGlob(`/**/*.{${EXTENSIONS_TO_PROCESS}}`);
@@ -30,30 +33,42 @@ export default class AppVariant {
         this.id = id;
         this.layer = layer;
         this.content = content;
+        // Prefix is a subfolder for the app variant to store js, fragments,
+        // annotations and i18n files. It can be anything, but for convenience
+        // it is an app variant id.
+        this.prefix = dotToUnderscore(this.id);
     }
     getProcessedFiles() {
-        const files = new Map();
-        this.files.forEach((content, filename) => {
-            if (filename.startsWith(CHANGES_DIR)) {
-                if (!this.isManifestChange(filename, content)) {
-                    files.set(filename, rename(content, this.reference, this.id));
-                }
-            }
-            else if (filename !== "manifest.appdescr_variant") {
-                files.set(filename, content);
-            }
+        const { files, renamingPaths } = moveFiles(this.files, this.prefix, this.id);
+        // Directly rename files that with new paths, this ensures no conflict in further renaming
+        // In later remaming it's not possible to find correct prefix of moved files
+        return FilesUtil.rename(files, renamingPaths);
+    }
+    ;
+    /**
+     * Since we moved files, we need to update paths where they were referenced.
+     * To do this we use renameMap function along with renaming ids.
+     */
+    getRenamingForMovedFiles() {
+        const renaming = new Map();
+        const slashToDot = (str) => str.replaceAll("\/", ".");
+        this.renaming.forEach((newPath, oldPath) => {
+            renaming.set(slashToDot(oldPath), slashToDot(newPath));
         });
-        return files;
+        return renaming;
     }
+    ;
     getProcessedManifestChanges() {
-        // Order is important: apply manifest.json changes first, then *.change
-        // files. UI5 does the same.
+        // Order: manifest changes first, then *.change files
         const manifestChanges = structuredClone(this.content) ?? [];
         this.files.forEach((content, filename) => {
-            if (this.isManifestChange(filename, content)) {
-                const change = JSON.parse(rename(content, this.reference, this.id));
-                this.updateRelativePaths(change, filename);
-                manifestChanges.push(change);
+            if (filename.endsWith(CHANGES_EXT)) {
+                const change = JSON.parse(content);
+                if (isManifestChange(filename, content)) {
+                    const { newFilename } = moveFile(filename, content, this.prefix, this.id);
+                    this.updateRelativePaths(change, newFilename);
+                    manifestChanges.push(change);
+                }
             }
         });
         if (this.layer) {
@@ -77,13 +92,12 @@ export default class AppVariant {
             }
         }
     }
-    isManifestChange(filename, content) {
-        if (filename.endsWith(CHANGES_EXT)) {
-            const change = JSON.parse(content);
-            return change.changeType?.startsWith(MANIFEST_CHANGE);
-        }
-        return false;
-    }
+    /**
+     * 3p. We not only omit files, which were moved or deleted from the resulted
+     * file set, but also update existing adaptation project resources with
+     * renamed content, otherwise flexibility-bundle will contain not renamed
+     * content of files.
+     */
     omitDeletedResources(files, projectNamespace, taskUtil) {
         if (!this.resources) {
             return;
@@ -92,6 +106,11 @@ export default class AppVariant {
             const relativePath = ResourceUtil.relativeToRoot(resource.getPath(), projectNamespace);
             if (!files.has(relativePath)) {
                 taskUtil.setTag(resource, taskUtil.STANDARD_TAGS.OmitFromBuildResult, true);
+                if (this.movedFiles.has(relativePath)) {
+                    const newPath = this.movedFiles.get(relativePath);
+                    const renamedContent = files.get(newPath);
+                    resource.setString(renamedContent);
+                }
             }
         }
     }

package/dist/baseAppManager.d.ts

@@ -11,6 +11,13 @@ export interface IManifestIdVersion {
 export interface IManifestInfo extends IManifestIdVersion {
     i18nPath: string;
 }
+/**
+ * Processes files to replace .js file content with corresponding -dbg.js
+ * content and remove -dbg.js
+ * @param files - Map of all files
+ * @returns Map with .js files replaced by -dbg.js content where applicable
+ */
+export declare function preProcessFiles(files: ReadonlyMap<string, string>): Map<string, string>;
 export default class BaseApp {
     readonly id: string;
     readonly version: string;
@@ -19,11 +26,12 @@ export default class BaseApp {
     static fromFiles(files: ReadonlyMap<string, string>): BaseApp;
     private constructor();
     adapt(appVariant: AppVariant, processor: IProcessor): Promise<ReadonlyMap<string, string>>;
+    private updateComponentName;
     private updateAdaptationProperties;
     private extractI18nPathFromManifest;
-    private fillAppVariantIdHierarchy;
     private VALIDATION_RULES;
     private validateProperty;
     private applyDescriptorChanges;
+    private fillAppVariantIdHierarchy;
     private adjustAddNewModelEnhanceWith;
 }

package/dist/baseAppManager.js

@@ -1,14 +1,43 @@
 import { AppDescriptorChange, Applier, RegistrationBuild } from "../dist/bundle.js";
-import { dotToUnderscore, trimExtension } from "./util/commonUtil.js";
+import { trimExtension } from "./util/commonUtil.js";
 import BuildStrategy from "./buildStrategy.js";
 import { getLogger } from "@ui5/logger";
-import { renameResources } from "./util/commonUtil.js";
 const log = getLogger("@ui5/task-adaptation::BaseAppManager");
 const IGNORE_FILES = [
     "manifest-bundle.zip",
     "Component-preload.js",
     "sap-ui-cachebuster-info.json"
 ];
+/**
+ * Processes files to replace .js file content with corresponding -dbg.js
+ * content and remove -dbg.js
+ * @param files - Map of all files
+ * @returns Map with .js files replaced by -dbg.js content where applicable
+ */
+export function preProcessFiles(files) {
+    const processedFiles = new Map(files);
+    // Find all -dbg.js files that have corresponding .js files
+    for (const [filename, content] of files) {
+        if (filename.endsWith("-dbg.js")) {
+            const correspondingJsFile = filename.replace("-dbg.js", ".js");
+            if (files.has(correspondingJsFile)) {
+                // Replace the .js file content with the -dbg.js content
+                processedFiles.set(correspondingJsFile, content);
+                processedFiles.delete(filename);
+            }
+        }
+        else if (filename.endsWith("-dbg.js.map")) {
+            const correspondingJsFile = filename.replace("-dbg.js.map", ".js");
+            if (files.has(correspondingJsFile)) {
+                processedFiles.delete(filename);
+            }
+        }
+        if (IGNORE_FILES.some(ignoredFile => ignoredFile === filename)) {
+            processedFiles.delete(filename);
+        }
+    }
+    return processedFiles;
+}
 export default class BaseApp {
     id;
     version;
@@ -18,7 +47,7 @@ export default class BaseApp {
         return new BaseApp(files);
     }
     constructor(files) {
-        this.files = new Map([...files].filter(([filename]) => !IGNORE_FILES.includes(filename)));
+        this.files = preProcessFiles(files);
         const manifestString = files.get("manifest.json");
         if (!manifestString) {
             throw new Error("Original application should have manifest.json in root folder");
@@ -31,15 +60,25 @@ export default class BaseApp {
         this.i18nPath = this.extractI18nPathFromManifest(this.id, manifest["sap.app"]?.i18n);
     }
     async adapt(appVariant, processor) {
-        const files = renameResources(this.files, appVariant.reference, appVariant.id);
+        const files = new Map(this.files);
         const manifest = JSON.parse(files.get("manifest.json"));
-        await processor.updateLandscapeSpecificContent(manifest, files);
-        this.fillAppVariantIdHierarchy(processor, this.id, this.version, manifest);
+        manifest["sap.app"].id = appVariant.id;
+        await processor.updateLandscapeSpecificContent(manifest, files, appVariant.id, appVariant.prefix);
+        this.updateComponentName(manifest, this.id);
+        this.fillAppVariantIdHierarchy(processor, appVariant.reference, this.version, manifest);
         this.updateAdaptationProperties(manifest);
         await this.applyDescriptorChanges(manifest, appVariant);
         files.set("manifest.json", JSON.stringify(manifest));
         return files;
     }
+    updateComponentName(manifest, id) {
+        if (manifest["sap.ui5"] == null) {
+            manifest["sap.ui5"] = {};
+        }
+        if (manifest["sap.ui5"].componentName == null) {
+            manifest["sap.ui5"].componentName = id;
+        }
+    }
     updateAdaptationProperties(content) {
         if (content["sap.fiori"]?.cloudDevAdaptationStatus) {
             delete content["sap.fiori"].cloudDevAdaptationStatus;
@@ -63,17 +102,6 @@ export default class BaseApp {
         }
         return "i18n/i18n";
     }
-    fillAppVariantIdHierarchy(processor, id, version, baseAppManifest) {
-        log.verbose("Filling up app variant hierarchy in manifest.json");
-        if (baseAppManifest["sap.ui5"] == null) {
-            baseAppManifest["sap.ui5"] = {};
-        }
-        if (baseAppManifest["sap.ui5"].appVariantIdHierarchy == null) {
-            baseAppManifest["sap.ui5"].appVariantIdHierarchy = [];
-        }
-        const appVariantIdHierarchyItem = processor.createAppVariantHierarchyItem(id, version);
-        baseAppManifest["sap.ui5"].appVariantIdHierarchy.unshift(appVariantIdHierarchyItem);
-    }
     VALIDATION_RULES = new Map([["sap.app/id", (value) => {
                 if (!value.includes(".")) {
                     throw new Error(`The original application id '${value}' should consist of multiple segments split by dot, e.g.: original.id`);
@@ -91,7 +119,7 @@ export default class BaseApp {
     async applyDescriptorChanges(baseAppManifest, appVariant) {
         log.verbose("Applying appVariant changes");
         const changesContent = new Array();
-        const i18nBundleName = dotToUnderscore(appVariant.id);
+        const i18nBundleName = appVariant.prefix;
         for (const change of appVariant.getProcessedManifestChanges()) {
             changesContent.push(new AppDescriptorChange(change));
             this.adjustAddNewModelEnhanceWith(change, i18nBundleName);
@@ -101,6 +129,17 @@ export default class BaseApp {
             await Applier.applyChanges(baseAppManifest, changesContent, strategy);
         }
     }
+    fillAppVariantIdHierarchy(processor, id, version, baseAppManifest) {
+        log.verbose("Filling up app variant hierarchy in manifest.json");
+        if (baseAppManifest["sap.ui5"] == null) {
+            baseAppManifest["sap.ui5"] = {};
+        }
+        if (baseAppManifest["sap.ui5"].appVariantIdHierarchy == null) {
+            baseAppManifest["sap.ui5"].appVariantIdHierarchy = [];
+        }
+        const appVariantIdHierarchyItem = processor.createAppVariantHierarchyItem(id, version);
+        baseAppManifest["sap.ui5"].appVariantIdHierarchy.unshift(appVariantIdHierarchyItem);
+    }
     adjustAddNewModelEnhanceWith(change, i18nBundleName) {
         if (change.changeType === "appdescr_ui5_addNewModelEnhanceWith") {
             if (change.texts == null) {