@ui5/task-adaptation 1.0.18 → 1.0.20

package/CHANGELOG.md

@@ -2,7 +2,13 @@
 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.0.18...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.0.20...HEAD).
+
+<a name="v1.0.20"></a>
+## [v1.0.20] - 2024-01-02
+
+<a name="v1.0.19"></a>
+## [v1.0.19] - 2023-11-16
 
 <a name="v1.0.18"></a>
 ## [v1.0.18] - 2023-11-10
@@ -52,6 +58,8 @@ 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.0.20]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.19...v1.0.20
+[v1.0.19]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.18...v1.0.19
 [v1.0.18]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.17...v1.0.18
 [v1.0.17]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.16...v1.0.17
 [v1.0.16]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.11...v1.0.16

package/dist/annotationManager.d.ts

@@ -13,7 +13,7 @@ export default class AnnotationManager {
     private normalizeAppVariantId;
     private createAnnotationFile;
     private downloadAnnotations;
-    private updateManifest;
+    private updateManifestModel;
     private updateManifestDataSources;
     private createManifestModel;
     private enhanceManifestModel;

package/dist/annotationManager.js

@@ -17,7 +17,7 @@ class AnnotationManager {
         this.abapRepoManager = abapRepoManager;
     }
     async process(renamedBaseAppManifest, languages) {
-        const { id } = baseAppManager_1.default.getManifestInfo(renamedBaseAppManifest);
+        const { id } = baseAppManager_1.default.getIdVersion(renamedBaseAppManifest);
         baseAppManager_1.default.validateProperty(id, "sap.app/id");
         const normalisedId = this.normalizeAppVariantId(id);
         //TODO: switch to this after resolving @i18n custom model
@@ -35,7 +35,10 @@ class AnnotationManager {
             metaInfo.push({ annotationFileName, annotationName });
         }
         if (metaInfo.length > 0) {
-            this.updateManifest(renamedBaseAppManifest, metaInfo, modelName, i18nPathName);
+            this.updateManifestDataSources(renamedBaseAppManifest, metaInfo);
+            if (i18nManager.hasTranslations()) {
+                this.updateManifestModel(renamedBaseAppManifest, modelName, i18nPathName);
+            }
         }
         const i18nFiles = i18nManager.createFiles(i18nPathName);
         return new Map([...annotationFiles, ...i18nFiles]);
@@ -58,12 +61,11 @@ class AnnotationManager {
             annotationName: name
         }));
     }
-    updateManifest(renamedBaseAppManifest, metaInfo, modelName, i18nPathName) {
+    updateManifestModel(renamedBaseAppManifest, modelName, i18nPathName) {
         const uri = `${i18nPathName}/i18n.properties`;
         this.enhanceManifestModel(renamedBaseAppManifest, modelName, uri);
         //TODO: switch to this after resolving @i18n custom model
         //this.createManifestModel(renamedBaseAppManifest, modelName, uri);
-        this.updateManifestDataSources(renamedBaseAppManifest, metaInfo);
     }
     updateManifestDataSources(renamedBaseAppManifest, metaInfo) {
         const dataSources = renamedBaseAppManifest[SAPAPP]?.dataSources;

package/dist/appVariantManager.d.ts

@@ -3,8 +3,15 @@ export default class AppVariantManager {
     static process(appVariantResources: any[], projectNamespace: string, taskUtil: any): Promise<IAppVariantInfo>;
     static getAppVariantResources(workspace: any): Promise<any[]>;
     static renameChanges(appVariantResources: any[], projectNamespace: string, appVariantInfo: IAppVariantInfo): Promise<void>;
+    private static isManifestChange;
+    private static isManifestAppVariant;
     static getAppVariantInfo(appVariantResources: any[]): Promise<IAppVariantInfo>;
-    static writeI18nToModule(resource: any, projectNamespace: string, i18nBundleName: string): void;
     private static omitFiles;
-    private static adjustAddNewModelEnhanceWith;
+    /**
+     * We need to add texts properties to changes because not all have texts property.
+     * Changes without texts property can causes issues in bundle.js
+     * This is needed for now, and will be removed as soon as change merger in openUI5 is updated
+     * @param changes
+     */
+    private static patchMissingTextsNode;
 }

package/dist/appVariantManager.js

@@ -4,19 +4,14 @@ const commonUtil_1 = require("./util/commonUtil");
 const resourceUtil_1 = require("./util/resourceUtil");
 const path_1 = require("path");
 const log = require("@ui5/logger").getLogger("@ui5/task-adaptation::AppVariantManager");
-const OMIT_FILES = ["manifest.appdescr_variant"];
-const OMIT_FOLDERS = [];
 const EXTENSIONS = "js,json,xml,html,properties,change,appdescr_variant";
-const MANIFEST_APP_VARIANT = "manifest.appdescr_variant";
 class AppVariantManager {
     static async process(appVariantResources, projectNamespace, taskUtil) {
         const appVariantInfo = await this.getAppVariantInfo(appVariantResources);
-        const i18nBundleName = (0, commonUtil_1.replaceDots)(appVariantInfo.id);
         for (const resource of appVariantResources) {
-            this.writeI18nToModule(resource, projectNamespace, i18nBundleName);
             this.omitFiles(resource, taskUtil);
         }
-        this.adjustAddNewModelEnhanceWith(appVariantInfo?.manifest?.content ?? [], i18nBundleName);
+        this.patchMissingTextsNode(appVariantInfo?.manifest?.content ?? []);
         await this.renameChanges(appVariantResources, projectNamespace, appVariantInfo);
         return appVariantInfo;
     }
@@ -41,20 +36,26 @@ class AppVariantManager {
             resourceUtil_1.default.setString(resource, renamedContent);
         });
     }
-    static async getAppVariantInfo(appVariantResources) {
+    static isManifestChange(resource) {
         const changesManifestFolder = path_1.posix.join("changes", "manifest");
+        const dirname = path_1.posix.dirname(resource.getPath());
+        return dirname.endsWith(changesManifestFolder);
+    }
+    static isManifestAppVariant(resource) {
+        const MANIFEST_APP_VARIANT = "manifest.appdescr_variant";
+        const basename = path_1.posix.basename(resource.getPath());
+        return basename === MANIFEST_APP_VARIANT;
+    }
+    static async getAppVariantInfo(appVariantResources) {
         let manifest;
         const manifestChanges = [];
         for (const resource of appVariantResources) {
-            const resourcePath = resource.getPath();
-            const dirname = path_1.posix.dirname(resource.getPath());
-            const basename = path_1.posix.basename(resourcePath);
-            if (basename === MANIFEST_APP_VARIANT) {
+            if (this.isManifestAppVariant(resource)) {
                 manifest = await resourceUtil_1.default.getString(resource).then(JSON.parse);
             }
-            else if (dirname.endsWith(changesManifestFolder)) {
-                const str = await resourceUtil_1.default.getString(resource);
-                manifestChanges.push(JSON.parse(str));
+            else if (this.isManifestChange(resource)) {
+                const content = await resourceUtil_1.default.getString(resource);
+                manifestChanges.push(JSON.parse(content));
             }
         }
         if (manifest) {
@@ -67,28 +68,24 @@ class AppVariantManager {
         }
         throw new Error("Adaptation project should contain manifest.appdescr_variant");
     }
-    static writeI18nToModule(resource, projectNamespace, i18nBundleName) {
-        if (path_1.posix.extname(resource.getPath()) === ".properties") {
-            let rootFolder = resourceUtil_1.default.getRootFolder(projectNamespace);
-            resource.setPath(path_1.posix.join(rootFolder, i18nBundleName, resource.getPath().substring(rootFolder.length)));
-        }
-    }
     static omitFiles(resource, taskUtil) {
-        const dirname = path_1.posix.dirname(resource.getPath());
-        const filename = path_1.posix.basename(resource.getPath());
-        if (OMIT_FILES.includes(filename) ||
-            OMIT_FOLDERS.some(folder => dirname.endsWith(folder))) {
+        if (this.isManifestAppVariant(resource) || this.isManifestChange(resource)) {
             taskUtil.setTag(resource, taskUtil.STANDARD_TAGS.OmitFromBuildResult, true);
         }
     }
-    static adjustAddNewModelEnhanceWith(changes, i18nBundleName) {
+    /**
+     * We need to add texts properties to changes because not all have texts property.
+     * Changes without texts property can causes issues in bundle.js
+     * This is needed for now, and will be removed as soon as change merger in openUI5 is updated
+     * @param changes
+     */
+    static patchMissingTextsNode(changes) {
         log.verbose("Adjusting appdescr_ui5_addNewModelEnhanceWith with module");
         for (const change of changes) {
             if (change.changeType === "appdescr_ui5_addNewModelEnhanceWith") {
-                if (!change.texts) {
-                    change.texts = { i18n: "i18n/i18n.properties" };
+                if (!change.texts && change.content?.bundleUrl) {
+                    change.texts = { i18n: change.content.bundleUrl };
                 }
-                change.texts.i18n = i18nBundleName + "/" + change.texts.i18n;
             }
         }
     }

package/dist/baseAppManager.d.ts

@@ -4,17 +4,24 @@ export interface IBaseAppResources {
     resources: any[];
     manifestInfo: IManifestInfo;
 }
-export interface IManifestInfo {
+export interface IManifestIdVersion {
     id: string;
     version: string;
 }
+export interface IManifestInfo extends IManifestIdVersion {
+    i18nPath: string;
+}
 export default class BaseAppManager {
     static process(baseAppFiles: Map<string, string>, appVariantInfo: IAppVariantInfo, options: IProjectOptions, processor: IProcessor): Promise<IBaseAppResources>;
     private static updateAdaptationProperties;
+    static getIdVersion(manifest: any): IManifestIdVersion;
     static getManifestInfo(manifest: any): IManifestInfo;
+    private static extractI18nPathFromManifest;
+    private static extractI18NFromBundleName;
+    private static extractI18NFromBundleUrl;
     private static getBaseAppManifest;
     private static fillAppVariantIdHierarchy;
     static validateProperty(value: string, property: string): void;
-    static applyDescriptorChanges(baseAppManifest: any, appVariantInfo: IAppVariantInfo, i18nBundleName: string): Promise<void>;
+    static applyDescriptorChanges(baseAppManifest: any, appVariantInfo: IAppVariantInfo): Promise<void>;
     static writeToWorkspace(baseAppFiles: Map<string, string>, projectNamespace: string): any[];
 }

package/dist/baseAppManager.js

@@ -4,20 +4,20 @@ const commonUtil_1 = require("./util/commonUtil");
 const buildStrategy_1 = require("./buildStrategy");
 const resourceUtil_1 = require("./util/resourceUtil");
 const path_1 = require("path");
-const { RegistrationBuild, ApplyUtil, Applier, Change } = require("../dist/bundle");
+const commonUtil_2 = require("./util/commonUtil");
+const { RegistrationBuild, Applier, Change } = require("../dist/bundle");
 const resourceFactory = require("@ui5/fs/lib/resourceFactory");
 const log = require("@ui5/logger").getLogger("@ui5/task-adaptation::BaseAppManager");
 class BaseAppManager {
     static async process(baseAppFiles, appVariantInfo, options, processor) {
         const baseAppManifest = this.getBaseAppManifest(baseAppFiles);
-        const { id, version } = this.getManifestInfo(baseAppManifest.content);
+        const { id, version } = this.getIdVersion(baseAppManifest.content);
         const renamedBaseAppFiles = (0, commonUtil_1.renameResources)(baseAppFiles, appVariantInfo.reference, appVariantInfo.id);
         const { filepath, content } = this.getBaseAppManifest(renamedBaseAppFiles);
         await processor.updateLandscapeSpecificContent(content, renamedBaseAppFiles);
         this.fillAppVariantIdHierarchy(processor, id, version, content);
         this.updateAdaptationProperties(content);
-        const i18nBundleName = (0, commonUtil_1.replaceDots)(appVariantInfo.id);
-        await this.applyDescriptorChanges(content, appVariantInfo, i18nBundleName);
+        await this.applyDescriptorChanges(content, appVariantInfo);
         renamedBaseAppFiles.set(filepath, JSON.stringify(content));
         return {
             resources: this.writeToWorkspace(renamedBaseAppFiles, options.projectNamespace),
@@ -33,11 +33,31 @@ class BaseAppManager {
         }
         content["sap.ui5"].isCloudDevAdaptation = true;
     }
-    static getManifestInfo(manifest) {
+    static getIdVersion(manifest) {
         const id = manifest["sap.app"]?.id;
         const version = manifest["sap.app"]?.applicationVersion?.version;
         return { id, version };
     }
+    static getManifestInfo(manifest) {
+        const { id, version } = this.getIdVersion(manifest);
+        const i18nNode = manifest["sap.app"]?.i18n;
+        const i18nPath = this.extractI18nPathFromManifest(id, i18nNode);
+        return { id, version, i18nPath };
+    }
+    static extractI18nPathFromManifest(sapAppId, i18nNode) {
+        if (typeof i18nNode === "object") {
+            return i18nNode["bundleUrl"] ? this.extractI18NFromBundleUrl(i18nNode) : this.extractI18NFromBundleName(i18nNode, sapAppId);
+        }
+        else {
+            return `${sapAppId?.replaceAll(".", "/")}/${i18nNode}`;
+        }
+    }
+    static extractI18NFromBundleName(i18nNode, sapAppId) {
+        return i18nNode["bundleName"].replace(sapAppId, "").replaceAll(".", "/").substring(1);
+    }
+    static extractI18NFromBundleUrl(i18nNode) {
+        return (0, commonUtil_2.removePropertiesExtension)(i18nNode["bundleUrl"]);
+    }
     static getBaseAppManifest(baseAppFiles) {
         let filepath = [...baseAppFiles.keys()].find(filepath => filepath.endsWith("manifest.json"));
         if (filepath) {
@@ -66,9 +86,9 @@ class BaseAppManager {
             throw new Error(`Original application manifest should have ${property}`);
         }
     }
-    static async applyDescriptorChanges(baseAppManifest, appVariantInfo, i18nBundleName) {
+    static async applyDescriptorChanges(baseAppManifest, appVariantInfo) {
         log.verbose("Applying appVariant changes");
-        const strategy = new buildStrategy_1.default(RegistrationBuild, ApplyUtil, i18nBundleName);
+        const strategy = new buildStrategy_1.default(RegistrationBuild);
         const { manifest } = appVariantInfo;
         const allChanges = [
             ...manifest.content,

package/dist/buildStrategy.d.ts

@@ -1,10 +1,7 @@
-import { IChangeText } from "./model/types";
 export default class BuildStrategy {
     private registrationBuild;
-    private applyUtil;
-    private i18nBundleName;
-    constructor(registrationBuild: any, applyUtil: any, i18nBundleName: string);
+    constructor(registrationBuild: any);
     registry(): Promise<any>;
     handleError(error: any): void;
-    processTexts(manifest: any, changeTexts: IChangeText): any;
+    processTexts(manifest: any): any;
 }

package/dist/buildStrategy.js

@@ -1,10 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 class BuildStrategy {
-    constructor(registrationBuild, applyUtil, i18nBundleName) {
+    constructor(registrationBuild) {
         this.registrationBuild = registrationBuild;
-        this.applyUtil = applyUtil;
-        this.i18nBundleName = i18nBundleName;
     }
     registry() {
         return Promise.resolve(this.registrationBuild);
@@ -12,21 +10,10 @@ class BuildStrategy {
     handleError(error) {
         throw error;
     }
-    processTexts(manifest, changeTexts) {
+    processTexts(manifest) {
         if (typeof manifest["sap.app"].i18n === "string") {
             manifest["sap.app"].i18n = { bundleUrl: manifest["sap.app"].i18n };
         }
-        if (manifest["sap.app"].i18n == null) {
-            manifest["sap.app"].i18n = {};
-        }
-        if (manifest["sap.app"].i18n.enhanceWith == null) {
-            manifest["sap.app"].i18n.enhanceWith = [];
-        }
-        const bundleName = this.applyUtil.formatBundleName(manifest["sap.app"].id + "." + this.i18nBundleName, changeTexts.i18n);
-        const doubles = manifest["sap.app"].i18n.enhanceWith.some((entry) => entry.bundleName === bundleName);
-        if (!doubles) {
-            manifest["sap.app"].i18n.enhanceWith.push({ bundleName: bundleName });
-        }
         return manifest;
     }
 }

package/dist/i18nManager.d.ts

@@ -39,5 +39,6 @@ export default class I18nManager {
     private replaceWithModelReference;
     private createReference;
     getUniqueKeyForValue(value: string): string;
+    hasTranslations(): boolean;
     private initPropertyValues;
 }

package/dist/i18nManager.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.I18nFileContent = exports.PropertyValue = void 0;
 const jsonDiffUtil_1 = require("./util/jsonDiffUtil");
 const annotationDiffStructureError_1 = require("./model/annotationDiffStructureError");
-const path_1 = require("path");
+const posix_1 = require("path/posix"); // Ensure standardized dir separators to ensure Windows compatibility
 // To generate keys, english language is more common, so compare all other
 // languages with it
 const DEFAULT_LANGUAGES = ["", "EN", "EN_US", "EN_GB"];
@@ -74,7 +74,7 @@ class I18nFileContent {
                 if (language) {
                     filename += "_" + language.toLowerCase();
                 }
-                const filepath = (0, path_1.join)(i18nPathName, filename + ".properties");
+                const filepath = (0, posix_1.join)(i18nPathName, filename + ".properties");
                 files.set(filepath, [...i18nLines].map(([key, value]) => `${key}=${value}`).join("\n"));
             });
         }
@@ -195,6 +195,9 @@ class I18nManager {
         this.existingKeys.add(key);
         return key;
     }
+    hasTranslations() {
+        return this.i18nFileContent.hasTranslations();
+    }
     initPropertyValues(diff, propertyValues) {
         propertyValues.forEach(prop => prop.set(diff, this.references));
     }

package/dist/index.js

@@ -4,6 +4,7 @@ const dotenv = require("dotenv");
 const appVariantManager_1 = require("./appVariantManager");
 const baseAppManager_1 = require("./baseAppManager");
 const processor_1 = require("./processors/processor");
+const i18nMerger_1 = require("./util/i18nMerger");
 /**
  * Creates an appVariant bundle from the provided resources.
  */
@@ -14,8 +15,9 @@ module.exports = ({ workspace, options, taskUtil }) => {
         const appVariantResources = await appVariantManager_1.default.getAppVariantResources(workspace);
         const appVariantInfo = await appVariantManager_1.default.process(appVariantResources, options.projectNamespace, taskUtil);
         const baseAppFiles = await processor.getBaseAppFiles(appVariantInfo.reference);
-        const { resources } = await baseAppManager_1.default.process(baseAppFiles, appVariantInfo, options, processor);
-        await Promise.all(appVariantResources.concat(resources).map(resource => workspace.write(resource)));
+        const { resources, manifestInfo } = await baseAppManager_1.default.process(baseAppFiles, appVariantInfo, options, processor);
+        const mergedResources = await i18nMerger_1.default.mergeI18NFiles(resources, appVariantResources, options.projectNamespace, manifestInfo.i18nPath, appVariantInfo, taskUtil);
+        await Promise.all(mergedResources.map(resource => workspace.write(resource)));
     }
     return process(workspace, taskUtil);
 };

package/dist/model/types.d.ts

@@ -69,12 +69,19 @@ export interface IAppVariantManifest {
 }
 export interface IChange {
     changeType: string;
-    texts: IChangeText;
+    texts?: IChangeText;
     layer?: string;
+    content?: IChangeContent;
 }
 export interface IChangeText {
     i18n: string;
 }
+export interface IChangeContent {
+    bundleUrl?: string;
+    fallbackLocale?: string;
+    modelId?: string;
+    supportedLocales?: string[];
+}
 export interface ITaskParameters {
     workspace: any;
     options: IProjectOptions;

package/dist/util/commonUtil.d.ts

@@ -1,3 +1,5 @@
-export declare function replaceDots(value: string): string;
+export declare function dotToUnderscore(value: string): string;
 export declare function validateObject<T extends Object>(options: T, properties: Array<keyof T>, message: string): void;
+export declare function escapeRegex(update: string): string;
 export declare function renameResources(files: Map<string, string>, search: string, replacement: string): Map<string, string>;
+export declare function removePropertiesExtension(filePath: string): string;

package/dist/util/commonUtil.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.renameResources = exports.validateObject = exports.replaceDots = void 0;
-function replaceDots(value) {
+exports.removePropertiesExtension = exports.renameResources = exports.escapeRegex = exports.validateObject = exports.dotToUnderscore = void 0;
+function dotToUnderscore(value) {
     return value.replace(/\./g, "_");
 }
-exports.replaceDots = replaceDots;
+exports.dotToUnderscore = dotToUnderscore;
 function validateObject(options, properties, message) {
     for (const property of properties) {
         if (!options[property]) {
@@ -13,36 +13,51 @@ function validateObject(options, properties, message) {
     }
 }
 exports.validateObject = validateObject;
+function escapeRegex(update) {
+    return update.replaceAll(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
+}
+exports.escapeRegex = escapeRegex;
 function renameResources(files, search, replacement) {
-    const escapeRegexSpecialChars = (update) => update.replaceAll(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
     // The current regex works if the old Id is contained in the new Id, given
     // that they do not have the same beginning.
     // more complete alternative: /((?<!newIdStart)|(?!newIdEnd))oldId/g
+    let escapedSearch;
     if (replacement.includes(search)) {
         const [before, _] = replacement.split(search);
         // Matches a position in the string that is not immediately preceded by
-        // the string "before".
-        search = `(?<!${escapeRegexSpecialChars(before)})${escapeRegexSpecialChars(search)}`;
+        // the string "before". Since we won't replace anyway, we should also
+        // ignore one with the slashes.
+        const escapedBefore = escapeRegex(before).replaceAll("\\.", "[\\./]");
+        escapedSearch = `(?<!${escapedBefore})${escapeRegex(search)}`;
     }
     else {
-        search = escapeRegexSpecialChars(search);
+        escapedSearch = escapeRegex(search);
     }
     const dotToSlash = (update) => update.replaceAll(".", "\/");
-    const replaces = [
-        {
-            regexp: new RegExp(search, "g"),
-            replacement
-        },
-        {
-            regexp: new RegExp(dotToSlash(search), "g"),
-            replacement: dotToSlash(replacement)
+    const replace = (content) => content.replace(new RegExp(escapedSearch, "g"), replacement);
+    const replaceWithSlashesOnly = (content) => {
+        if (!search.includes(".")) {
+            return content;
         }
-    ];
+        let searchWithSlashes = dotToSlash(escapedSearch);
+        return content.replace(new RegExp(searchWithSlashes, "g"), dotToSlash(replacement));
+    };
     const renamed = new Map();
     files.forEach((content, filepath) => {
-        renamed.set(filepath, replaces.reduce((p, c) => p.replace(c.regexp, c.replacement), content));
+        // Finds the id with dots (test.id) or without dots (id) and replaces it
+        content = replace(content);
+        // Only if the id has dots, these dots will be replaced with slashes
+        // first, and then it will search for the id with slashes and replace
+        // with the appVariantId also with slashes
+        content = replaceWithSlashesOnly(content);
+        renamed.set(filepath, content);
     });
     return renamed;
 }
 exports.renameResources = renameResources;
+function removePropertiesExtension(filePath) {
+    const lastIndexOf = filePath.lastIndexOf(".properties");
+    return filePath.substring(0, lastIndexOf);
+}
+exports.removePropertiesExtension = removePropertiesExtension;
 //# sourceMappingURL=commonUtil.js.map

package/dist/util/i18nMerger.d.ts

@@ -0,0 +1,28 @@
+import { IAppVariantInfo } from "../model/types";
+export default class I18NMerger {
+    static analyzeAppVariantManifestChanges(rootFolder: string, tranlsationRegexPattern: string, appVariantInfo: IAppVariantInfo): {
+        mergePathsRegex: RegExp[];
+        copyPathsRegex: RegExp[];
+    };
+    static mergeI18NFiles(baseAppResources: any[], appVariantResources: any[], projectNamespace: string, baseAppManifestI18NPath: string, appVariantInfo: IAppVariantInfo, taskUtil: any): Promise<any[]>;
+    /**
+     *  Merge/Append base property file with property file from app variant
+     * FIXME Currently merge could duplicate keys which causes undefined
+     * behavior => Existing keys which are in merge content must be removed =>
+     * Actually only descriptor texts are relevant for merge which always have
+     * app variant Id as prefix => If we filter on them we do not need to remove
+     * existing overwritten keys (as there should be none)
+     */
+    private static mergePropertiesFiles;
+    /**
+     * update the path of app variant property file so it will be copied into
+     <app_variant_id> folder
+     */
+    private static moveToAppVarSubfolder;
+    /**
+     * create new i18n file in case e.g. translation file does not exist in base
+     * app but in variant and copy of translation file is needed
+     */
+    private static createFile;
+    private static mergeFiles;
+}

package/dist/util/i18nMerger.js

@@ -0,0 +1,104 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const commonUtil_1 = require("./commonUtil");
+const resourceUtil_1 = require("./resourceUtil");
+const path_1 = require("path");
+const Resource = require("@ui5/fs/lib/Resource");
+class I18NMerger {
+    static analyzeAppVariantManifestChanges(rootFolder, tranlsationRegexPattern, appVariantInfo) {
+        // check which files need to be copied and which files need to be merged and copied
+        // this is necessary because lrep does not support multiple enhanceWith with multiple locations
+        const mergePaths = new Set();
+        const copyPaths = new Set();
+        const { manifest, manifestChanges } = appVariantInfo;
+        manifestChanges.concat(manifest.content).forEach((change) => {
+            const i18nPathWithExtension = change.content?.bundleUrl || change.texts?.i18n;
+            if (i18nPathWithExtension) {
+                // build regex to match specific + language related files
+                const i18nPath = (0, commonUtil_1.removePropertiesExtension)(i18nPathWithExtension);
+                const resourcePath = path_1.posix.join(rootFolder, i18nPath);
+                const regex = new RegExp((0, commonUtil_1.escapeRegex)(resourcePath) + tranlsationRegexPattern);
+                if (change.changeType.includes("addNewModelEnhanceWith")) {
+                    copyPaths.add(regex);
+                }
+                else {
+                    mergePaths.add(regex);
+                }
+            }
+        });
+        return { mergePathsRegex: [...mergePaths.values()], copyPathsRegex: [...copyPaths.values()] };
+    }
+    static async mergeI18NFiles(baseAppResources, appVariantResources, projectNamespace, baseAppManifestI18NPath, appVariantInfo, taskUtil) {
+        const aggregatedResourceFilesMap = new Map(baseAppResources.map(baseAppResource => [baseAppResource.getPath(), baseAppResource]));
+        const i18nTargetFolder = (0, commonUtil_1.dotToUnderscore)(appVariantInfo.id);
+        const rootFolder = resourceUtil_1.default.getRootFolder(projectNamespace);
+        const tranlsationRegexPattern = "((_[a-z]{2,3})?(_[a-zA-Z]{2,3}(_[a-zA-Z]{2,20})?)?)\.properties$";
+        const { copyPathsRegex: copyPathsValues, mergePathsRegex: mergePathsValues } = this.analyzeAppVariantManifestChanges(rootFolder, tranlsationRegexPattern, appVariantInfo);
+        for (const appVariantResource of appVariantResources) {
+            const appVariantResourcePath = appVariantResource.getPath();
+            if (appVariantResourcePath.endsWith(".properties")) {
+                // merge/copy logic
+                // check if file matches with regex in merge/copy
+                const mergePathMatch = mergePathsValues.map(path => appVariantResourcePath.match(path)).find(match => match);
+                const shouldMergeFile = !!mergePathMatch;
+                const shouldCopyFile = copyPathsValues.map(path => appVariantResourcePath.match(path)).find(match => match);
+                if (shouldMergeFile) {
+                    let baseAppI18NPath = `${rootFolder}/${baseAppManifestI18NPath}${mergePathMatch[1] || ""}.properties`;
+                    await this.mergePropertiesFiles(aggregatedResourceFilesMap, appVariantResource, baseAppI18NPath);
+                }
+                // Resource for to be copied file already exists so we only have to adjust path 
+                // Otherwise we have to omit it. We always change the path to avoid omitting a base app file
+                this.moveToAppVarSubfolder(appVariantResource, rootFolder, i18nTargetFolder);
+                if (!shouldCopyFile) {
+                    taskUtil.setTag(appVariantResource, taskUtil.STANDARD_TAGS.OmitFromBuildResult, true);
+                }
+            }
+            aggregatedResourceFilesMap.set(appVariantResource.getPath(), appVariantResource);
+        }
+        return Array.from(aggregatedResourceFilesMap.values());
+    }
+    /**
+     *  Merge/Append base property file with property file from app variant
+     * FIXME Currently merge could duplicate keys which causes undefined
+     * behavior => Existing keys which are in merge content must be removed =>
+     * Actually only descriptor texts are relevant for merge which always have
+     * app variant Id as prefix => If we filter on them we do not need to remove
+     * existing overwritten keys (as there should be none)
+     */
+    static async mergePropertiesFiles(aggregatedResourceFilesMap, variantResource, baseAppI18NPath) {
+        const baseAppI18NFile = aggregatedResourceFilesMap.get(baseAppI18NPath);
+        if (baseAppI18NFile) {
+            await this.mergeFiles(baseAppI18NFile, variantResource);
+        }
+        else {
+            // create the merge target file if it missing in base app. Maybe the language does not exist in the base app.
+            // Since the file might also be copied we do not just change the path of it but create another resource
+            await this.createFile(aggregatedResourceFilesMap, baseAppI18NPath, variantResource);
+        }
+    }
+    /**
+     * update the path of app variant property file so it will be copied into
+     <app_variant_id> folder
+     */
+    static moveToAppVarSubfolder(variantResource, rootFolder, i18nBundleName) {
+        const relativeFilePath = variantResource.getPath().substring(rootFolder.length);
+        const newResourcePath = path_1.posix.join(rootFolder, i18nBundleName, relativeFilePath);
+        variantResource.setPath(newResourcePath);
+    }
+    /**
+     * create new i18n file in case e.g. translation file does not exist in base
+     * app but in variant and copy of translation file is needed
+     */
+    static async createFile(aggregatedResourceFilesMap, path, resource) {
+        const createdFile = await resource.clone();
+        createdFile.setPath(path);
+        aggregatedResourceFilesMap.set(path, createdFile);
+    }
+    static async mergeFiles(baseFile, variantFile) {
+        const variantFileContent = await variantFile.getString();
+        const mergedFileContent = await baseFile.getString();
+        baseFile.setString(`${mergedFileContent}\n\n#App variant specific text file\n\n${variantFileContent}`);
+    }
+}
+exports.default = I18NMerger;
+//# sourceMappingURL=i18nMerger.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.0.18",
+    "version": "1.0.20",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
@@ -11,7 +11,7 @@
         "coverage-verbose": "nyc --reporter=html --reporter=text mocha -r ts-node/register 'test/**/*.spec.ts'",
         "preversion": "npm test",
         "version": "git-chglog --next-tag v$npm_package_version -o CHANGELOG.md && git add CHANGELOG.md",
-        "postversion": "git push --follow-tags",
+        "prepublishOnly": "git push --follow-tags",
         "release-note": "git-chglog -c .chglog/release-config.yml v$npm_package_version",
         "rollup": "npx ts-node scripts/rollup.ts",
         "build": "npm run rollup && tsc -p ./"
@@ -40,7 +40,7 @@
         "@ui5/project": "^2.6.0",
         "adm-zip": "^0.5.5",
         "amdextract": "^3.0.0",
-        "axios": "^0.25.0",
+        "axios": "^1.6.0",
         "builtin-modules": "^3.2.0",
         "dotenv": "^16.0.3",
         "js-yaml": "^4.1.0",