@ui5/task-adaptation 1.0.8 → 1.0.11

package/CHANGELOG.md

@@ -2,7 +2,16 @@
 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.8...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.0.11...HEAD).
+
+<a name="v1.0.11"></a>
+## [v1.0.11] - 2022-03-01
+
+<a name="v1.0.10"></a>
+## [v1.0.10] - 2021-06-04
+
+<a name="v1.0.9"></a>
+## [v1.0.9] - 2021-05-10
 
 <a name="v1.0.8"></a>
 ## [v1.0.8] - 2021-04-26
@@ -34,6 +43,9 @@ 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.11]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.10...v1.0.11
+[v1.0.10]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.9...v1.0.10
+[v1.0.9]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.8...v1.0.9
 [v1.0.8]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.7...v1.0.8
 [v1.0.7]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.6...v1.0.7
 [v1.0.6]: https://github.com/SAP/ui5-task-adaptation/compare/v1.0.5...v1.0.6

package/README.md

@@ -1,8 +1,34 @@
 # ui5-task-adaptation
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/ui5-task-adaptation)](https://api.reuse.software/info/github.com/SAP/ui5-task-adaptation)
+[![Build Status](https://app.travis-ci.com/SAP/ui5-task-adaptation.svg?branch=main)](https://travis-ci.org/SAP/ui5-task-adaptation)
+[![npm version](https://badge.fury.io/js/@ui5%2Ftask-adaptation.svg)](https://badge.fury.io/js/@ui5%2Ftask-adaptation)
 
 ## Description
-A custom task for [ui5-builder](https://github.com/SAP/ui5-builder) that allows building UI5 Flexibility adaptation projects for the SAP BTP, Cloud Foundry environment. Note: This feature is still in development and not available yet.
+A custom task for [ui5-builder](https://github.com/SAP/ui5-builder) that allows building [UI5 Flexibility adaptation projects](https://help.sap.com/viewer/584e0bcbfd4a4aff91c815cefa0bce2d/Cloud/en-US/019b0c38a6b043d1a66b11d992eed290.html) for SAP BTP, Cloud Foundry environment.
+
+## How to specify a UI5 version
+ui5-task-adaptation is based on the UI5 implementation. In order to use a certain UI5 version, go to a module that contains the ui5.yaml and edit the ui5.yaml specifying the desired UI5 version (1.89.0 in the example below):
+
+```yaml
+---
+specVersion: "2.2"
+type: application
+metadata:
+  name: example
+framework:
+  name: SAPUI5
+  version: 1.89.0
+  libraries:
+    - name: sap.ui.fl
+    - name: sap.suite.ui.generic.template
+```
+
+open a terminal and execute:
+
+```shell
+npm run build-ui5
+```
+
 
 ## How to obtain support
 In case you need any support, please create a GitHub issue.

package/dist/baseAppManager.d.ts

@@ -1,11 +1,12 @@
-import { IAppVariantInfo, IChange, IProjectOptions } from "./model/types";
+import { IAppVariantInfo, IAppVariantManifest, IProjectOptions } from "./model/types";
 export default class BaseAppManager {
     static process(baseAppFiles: Map<string, string>, appVariantInfo: IAppVariantInfo, options: IProjectOptions): Promise<any[]>;
-    static renameBaseApp(baseAppFiles: Map<string, string>, search: string, replacement: string): void;
+    private static getManifestInfo;
+    static renameBaseApp(baseAppFiles: Map<string, string>, search: string, replacement: string): Map<string, string>;
     private static getBaseAppManifest;
     private static updateCloudPlatform;
     private static fillAppVariantIdHierarchy;
     private static validateProperty;
-    static applyDescriptorChanges(baseAppManifest: any, changes: IChange[], i18nBundleName: string): Promise<void>;
+    static applyDescriptorChanges(baseAppManifest: any, appVariantManifest: IAppVariantManifest, i18nBundleName: string): Promise<void>;
     static writeToWorkspace(baseAppFiles: Map<string, string>, projectNamespace: string): any[];
 }

package/dist/baseAppManager.js

@@ -19,16 +19,24 @@ const log = require("@ui5/logger").getLogger("@ui5/task-adaptation::BaseAppManag
 class BaseAppManager {
     static process(baseAppFiles, appVariantInfo, options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const { filepath, content } = this.getBaseAppManifest(baseAppFiles);
-            this.renameBaseApp(baseAppFiles, appVariantInfo.reference, appVariantInfo.id);
+            const baseAppManifest = this.getBaseAppManifest(baseAppFiles);
+            const { id, version } = this.getManifestInfo(baseAppManifest.content);
+            const renamedBaseAppFiles = this.renameBaseApp(baseAppFiles, appVariantInfo.reference, appVariantInfo.id);
+            const { filepath, content } = this.getBaseAppManifest(renamedBaseAppFiles);
             this.updateCloudPlatform(content, options.configuration);
-            this.fillAppVariantIdHierarchy(content);
+            this.fillAppVariantIdHierarchy(id, version, content);
             const i18nBundleName = commonUtil_1.replaceDots(appVariantInfo.id);
-            yield this.applyDescriptorChanges(content, appVariantInfo.manifest.content, i18nBundleName);
-            baseAppFiles.set(filepath, JSON.stringify(content));
-            return this.writeToWorkspace(baseAppFiles, options.projectNamespace);
+            yield this.applyDescriptorChanges(content, appVariantInfo.manifest, i18nBundleName);
+            renamedBaseAppFiles.set(filepath, JSON.stringify(content));
+            return this.writeToWorkspace(renamedBaseAppFiles, options.projectNamespace);
         });
     }
+    static getManifestInfo(manifest) {
+        var _a, _b, _c;
+        const id = (_a = manifest["sap.app"]) === null || _a === void 0 ? void 0 : _a.id;
+        const version = (_c = (_b = manifest["sap.app"]) === null || _b === void 0 ? void 0 : _b.applicationVersion) === null || _c === void 0 ? void 0 : _c.version;
+        return { id, version };
+    }
     static renameBaseApp(baseAppFiles, search, replacement) {
         log.verbose("Renaming base app resources to appVariant id");
         const dotToSlash = (update) => update.split(".").join("\/");
@@ -43,9 +51,11 @@ class BaseAppManager {
                 replacement: dotToSlash(replacement)
             }
         ];
-        baseAppFiles.forEach((content, filepath, map) => {
-            map.set(filepath, replaces.reduce((p, c) => p.replace(c.regexp, c.replacement), content));
+        const renamed = new Map();
+        baseAppFiles.forEach((content, filepath) => {
+            renamed.set(filepath, replaces.reduce((p, c) => p.replace(c.regexp, c.replacement), content));
         });
+        return renamed;
     }
     static getBaseAppManifest(baseAppFiles) {
         let filepath = [...baseAppFiles.keys()].find(filepath => filepath.endsWith("manifest.json"));
@@ -74,31 +84,35 @@ class BaseAppManager {
             delete baseAppManifest["sap.cloud"];
         }
     }
-    static fillAppVariantIdHierarchy(baseAppManifest) {
-        var _a, _b, _c;
+    static fillAppVariantIdHierarchy(id, version, baseAppManifest) {
         log.verbose("Filling up app variant hierarchy in manifest.json");
-        const id = (_a = baseAppManifest["sap.app"]) === null || _a === void 0 ? void 0 : _a.id;
-        const version = (_c = (_b = baseAppManifest["sap.app"]) === null || _b === void 0 ? void 0 : _b.applicationVersion) === null || _c === void 0 ? void 0 : _c.version;
         this.validateProperty(id, "sap.app/id");
         this.validateProperty(version, "sap.app/applicationVersion/version");
         if (baseAppManifest["sap.ui5"] == null) {
             baseAppManifest["sap.ui5"] = {};
         }
-        baseAppManifest["sap.ui5"].appVariantIdHierarchy = [{
-                appVariantId: id,
-                version
-            }];
+        if (baseAppManifest["sap.ui5"].appVariantIdHierarchy == null) {
+            baseAppManifest["sap.ui5"].appVariantIdHierarchy = [];
+        }
+        baseAppManifest["sap.ui5"].appVariantIdHierarchy.unshift({
+            appVariantId: id,
+            version
+        });
     }
     static validateProperty(value, property) {
         if (!value) {
             throw new Error(`Original application manifest should have ${property}`);
         }
     }
-    static applyDescriptorChanges(baseAppManifest, changes, i18nBundleName) {
+    static applyDescriptorChanges(baseAppManifest, appVariantManifest, i18nBundleName) {
+        var _a, _b;
         return __awaiter(this, void 0, void 0, function* () {
             log.verbose("Applying appVariant changes");
             const strategy = new buildStrategy_1.default(RegistrationBuild, ApplyUtil, i18nBundleName);
-            const changesContent = changes === null || changes === void 0 ? void 0 : changes.map((change) => new Change(change));
+            if (appVariantManifest.layer) {
+                (_a = appVariantManifest.content) === null || _a === void 0 ? void 0 : _a.forEach(item => item.layer = appVariantManifest.layer);
+            }
+            const changesContent = (_b = appVariantManifest.content) === null || _b === void 0 ? void 0 : _b.map((change) => new Change(change));
             if (changesContent) {
                 yield Applier.applyChanges(baseAppManifest, changesContent, strategy);
             }