@ui5/task-adaptation 1.5.2 → 1.6.0

package/dist/util/resourceUtil.js

@@ -1,6 +1,6 @@
-import * as fs from "fs";
 import * as resourceFactory from "@ui5/fs/resourceFactory";
 import { posix as path } from "path";
+import * as fs from "fs/promises";
 const UTF8 = "utf8";
 export default class ResourceUtil {
     static getRootFolder(projectNamespace) {
@@ -17,6 +17,14 @@ export default class ResourceUtil {
     static getResourcePath(projectNamespace, ...paths) {
         return path.join(this.getRootFolder(projectNamespace), ...paths);
     }
+    /*
+     * Write files to the specified folder.
+     * NOTE: to write in project folder (folder where 'webapp',
+     * 'package.json', 'ui5.yaml' located), use writeInProject method.
+     * @param dir The directory to write files to.
+     * @param files A Map of file paths and their contents.
+     * @returns A promise that resolves when all files have been written.
+     */
     static write(dir, files) {
         const fsTarget = resourceFactory.createAdapter({
             fsBasePath: dir,
@@ -29,25 +37,65 @@ export default class ResourceUtil {
         });
         return Promise.all(promises);
     }
-    static _read(rootFolder, folder, files, exclude = []) {
-        const entries = fs.readdirSync(folder);
-        for (let entry of entries) {
-            const entryPath = path.join(folder, entry);
-            const stats = fs.lstatSync(entryPath);
-            if (stats.isFile() && !exclude.some(filepath => entryPath.endsWith(filepath))) {
-                const normalized = entryPath.substring(rootFolder.length + 1);
-                files.set(normalized, fs.readFileSync(entryPath, { encoding: "utf-8" }));
-            }
-            else if (stats.isDirectory()) {
-                this._read(rootFolder, entryPath, files, exclude);
+    /*
+     * Write files to the project folder (folder where 'webapp',
+     * 'package.json', 'ui5.yaml' located), use writeInProject method.
+     * @param dir The directory to write files to.
+     * @param files A Map of file paths and their contents.
+     * @returns A promise that resolves when all files have been written.
+     */
+    static writeInProject(dir, files) {
+        return ResourceUtil.write(path.join("./", dir), files);
+    }
+    /*
+     * Search files in the given folder, excluding specified glob patterns.
+     * NOTE: to search in project folder (folder where 'webapp',
+     * 'package.json', 'ui5.yaml' located), use byGlobInProject method.
+     * @param dir The directory to search in.
+     * @param pattern The glob pattern to match files, e.g., "/ui5AppInfo.json".
+     * @param excludes An array of glob patterns to exclude from the search.
+     * @returns A promise that resolves to a Map of file paths and their contents.
+     */
+    static byGlob(dir, pattern, excludes = []) {
+        const adapter = resourceFactory.createAdapter({
+            fsBasePath: dir,
+            virBasePath: "/",
+            excludes
+        });
+        return adapter.byGlob(pattern).then((resources) => this.toFileMap(resources));
+    }
+    /*
+     * Search files in the adaptation project (folder where 'webapp',
+     * 'package.json', 'ui5.yaml' located), excluding specified glob patterns.
+     * @param pattern The glob pattern to match files, e.g., "/ui5AppInfo.json".
+     * @param excludes An array of glob patterns to exclude from the search.
+     * @returns A promise that resolves to a Map of file paths and their contents.
+     */
+    static byGlobInProject(pattern, excludes = []) {
+        return ResourceUtil.byGlob("./", pattern, [
+            "/node_modules",
+            "/dist",
+            "/.adp/reuse"
+        ].concat(excludes));
+    }
+    /*
+     * Read the file by filepath from the project root (folder where 'webapp',
+     * 'package.json', 'ui5.yaml' located).
+     * @param filepath The relative file path from the project root (e.g. 'ui5AppInfo.json').
+     * @returns A promise that resolves to the file content as a string.
+     */
+    static async readInProject(filepath) {
+        try {
+            return await fs.readFile(path.resolve(process.cwd(), filepath), UTF8);
+        }
+        catch (error) {
+            const isProjectRoot = await ResourceUtil.fileExists(path.join(process.cwd(), "ui5.yaml"));
+            if (!isProjectRoot) {
+                throw new Error(`Please make sure that build has been started from the project root: ${error?.message ?? ""}`);
             }
+            throw error;
         }
     }
-    static read(folder) {
-        const files = new Map();
-        this._read(folder, folder, files);
-        return files;
-    }
     static getString(resource) {
         return resource.getBuffer().then((buffer) => buffer.toString(UTF8));
     }
@@ -57,6 +105,23 @@ export default class ResourceUtil {
     static setString(resource, str) {
         resource.setBuffer(Buffer.from(str, UTF8));
     }
+    /**
+     * Check whether a file or directory exists (non-throwing).
+     * @param filePath Absolute or relative path
+     * @returns true if the path exists, false if not
+     */
+    static async fileExists(filePath) {
+        try {
+            await fs.access(filePath);
+            return true;
+        }
+        catch (e) {
+            if (e?.code === "ENOENT") {
+                return false;
+            }
+            throw e;
+        }
+    }
     static createResource(filename, projectNamespace, content) {
         return resourceFactory.createResource({
             path: this.getResourcePath(projectNamespace, filename),
@@ -65,7 +130,7 @@ export default class ResourceUtil {
     }
     static async toFileMap(resources, projectNamespace) {
         const files = new Map();
-        const rootFolderLength = ResourceUtil.getRootFolder(projectNamespace).length;
+        const rootFolderLength = projectNamespace ? ResourceUtil.getRootFolder(projectNamespace).length : 0;
         for (const resource of resources) {
             files.set(resource.getPath().substring(rootFolderLength + 1), await ResourceUtil.getString(resource));
         }

package/eslint.config.js

@@ -3,7 +3,7 @@ import * as eslintimport from "eslint-plugin-import";
 import eslint from "@eslint/js";
 import tseslint from "typescript-eslint";
 
-export default tseslint.config(
+export default tseslint.config([
     eslint.configs.recommended,
     ...tseslint.configs.recommendedTypeChecked,
     {
@@ -12,7 +12,8 @@ export default tseslint.config(
                 project: [
                     "./tsconfig.json",
                     "./test/lib/tsconfig.json",
-                    "./scripts/tsconfig.json"
+                    "./scripts/tsconfig.json",
+                    "./rollup/tsconfig.json"
                 ],
                 tsconfigRootDir: import.meta.dirname,
             },
@@ -65,4 +66,4 @@ export default tseslint.config(
             "@typescript-eslint/no-unused-expressions": "off"
         },
     }
-);
+]);

package/package.json

@@ -1,19 +1,19 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.5.2",
+    "version": "1.6.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": "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'",
+        "dev": "UI5_LOG_LVL=error mocha --no-timeouts --no-warnings --import=tsx 'test/lib/**/*.spec.ts'",
+        "perf": "UI5_LOG_LVL=error mocha --no-timeouts --no-warnings --import=tsx 'test/lib/**/*.perf.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",
+        "rollup": "tsx rollup/rollup.ts",
         "build": "npm run rollup && tsc -p ./",
         "download-metadata": "tsx scripts/metadataDownloadHelper.ts"
     },
@@ -33,10 +33,10 @@
     "author": "SAP SE",
     "license": "Apache-2.0",
     "dependencies": {
-        "@sap-ux/axios-extension": "^1.16.6",
-        "@sap-ux/btp-utils": "^1.0.2",
-        "@sap-ux/store": "^0.9.1",
-        "@sap-ux/system-access": "^0.5.11",
+        "@sap-ux/axios-extension": "^1.22.9",
+        "@sap-ux/btp-utils": "^1.1.3",
+        "@sap-ux/store": "^1.1.4",
+        "@sap-ux/system-access": "^0.6.18",
         "@sap/cf-tools": "^3.2.2",
         "@ui5/fs": "^4.0.1",
         "@ui5/logger": "^4.0.1",
@@ -46,12 +46,11 @@
         "dotenv": "^16.0.3",
         "filenamify": "^6.0.0",
         "jsdom": "^23.0.1",
-        "temp-dir": "^2.0.0",
         "transliteration": "^2.3.5",
         "xml-js": "^1.6.11"
     },
     "devDependencies": {
-        "@buxlabs/amd-to-es6": "^0.16.3",
+        "@buxlabs/amd-to-es6": "^0.16.4",
         "@octokit/plugin-retry": "^8.0.1",
         "@octokit/rest": "^22.0.0",
         "@rollup/plugin-node-resolve": "^15.3.0",
@@ -65,29 +64,29 @@
         "@types/semver": "^7.3.8",
         "@types/sinon": "^10.0.16",
         "@types/yargs": "^17.0.33",
-        "@ui5/builder": "^4.0.3",
-        "@ui5/project": "^4.0.3",
+        "@ui5/builder": "^4.1.3",
+        "@ui5/project": "^4.0.9",
         "amdextract": "^3.0.0",
         "builtin-modules": "^3.2.0",
         "c8": "^10.1.3",
-        "chai": "^4.3.4",
-        "chai-as-promised": "^7.1.1",
+        "chai": "^6.2.1",
+        "chai-as-promised": "^8.0.2",
         "eslint": "^9.22.0",
         "eslint-plugin-import": "^2.31.0",
-        "esmock": "^2.6.3",
-        "glob": "^10.3.10",
+        "esmock": "^2.7.3",
+        "glob": "^13.0.0",
         "js-yaml": "^4.1.0",
         "meriyah": "^6.0.3",
         "minimatch": "^9.0.3",
-        "mocha": "^11.1.0",
+        "mocha": "^11.7.5",
         "mock-require": "^3.0.3",
         "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": "^8.26.1",
+        "tsx": "^4.21.0",
+        "typescript": "^5.9.3",
+        "typescript-eslint": "^8.48.1",
         "yargs": "^17.7.2"
     },
     "c8": {

package/rollup/amdToEsm.ts

@@ -0,0 +1,22 @@
+import { parse } from "meriyah";
+import { traverse } from "../src/util/commonUtil.js";
+
+export default function convert(content: string) {
+    return [
+        extractEsmClass
+    ].reduce((result, converter) => converter(result), content);
+}
+
+function extractEsmClass(content: string) {
+    const result = parse(content, { ranges: true });
+    let classCode: { start: number, end: number } | undefined;
+    traverse(result, [], (json, key) => {
+        if (key === "type" && json[key] === "ClassDeclaration") {
+            if (classCode) {
+                throw new Error("Only one class declaration per module is allowed");
+            }
+            classCode = json;
+        }
+    });
+    return classCode && "export default " + content.substring(classCode.start, classCode.end) || content;
+}

package/rollup/bundle.d.ts

@@ -0,0 +1,25 @@
+export declare const RegistrationBuild: any;
+
+export declare class RawApplier {
+    static applyChanges(changeHandlers: any[], manifest: any, changes: AppDescriptorChange[], strategy: any): Promise<void>;
+}
+
+export declare class AppDescriptorChange {
+    constructor(change: any);
+    getLayer(): string;
+    getChangeType(): string;
+}
+
+export declare class V2MetadataConverter {
+    convertXMLMetadata(jsdom: any): any;
+}
+
+export declare class V4MetadataConverter {
+    convertXMLMetadata(jsdom: any): any;
+}
+
+export declare class URI {
+    constructor(relativeUrl: string);
+    absoluteTo(url: string): string;
+    static parse(url: string): { path: string };
+}

package/rollup/bundleDefinition.js

@@ -0,0 +1,19 @@
+//Flex
+import AppDescriptorChange from "sap/ui/fl/apply/_internal/flexObjects/AppDescriptorChange";
+import RawApplier from "sap/ui/fl/apply/_internal/changes/descriptor/RawApplier";
+import RegistrationBuild from "sap/ui/fl/apply/_internal/changes/descriptor/RegistrationBuild";
+//OData
+import URI from "sap/ui/thirdparty/URI";
+import V2MetadataConverter from "sap/ui/model/odata/v4/lib/_V2MetadataConverter";
+import V4MetadataConverter from "sap/ui/model/odata/v4/lib/_V4MetadataConverter";
+
+export {
+    //Flex
+    AppDescriptorChange,
+    RawApplier,
+    RegistrationBuild,
+    //OData
+    URI,
+    V4MetadataConverter,
+    V2MetadataConverter
+};

package/rollup/bundler.ts

@@ -0,0 +1,35 @@
+import * as rollup from "rollup";
+import * as builtins from "builtin-modules";
+import ui5 from "./ui5Resolve.js";
+import { nodeResolve } from "@rollup/plugin-node-resolve";
+
+
+export default abstract class Bundler {
+
+    static async run(resources: Map<string, any>, input: string, output: string, skipTransformation: string[] = []): Promise<void> {
+        if (!skipTransformation.includes(input)) {
+            skipTransformation.push(input);
+        }
+        const inputOptions = <rollup.RollupOptions>{
+            input,
+            plugins: [
+                ui5({
+                    resources,
+                    skipTransformation,
+                    output
+                }),
+                nodeResolve({
+                    preferBuiltins: true
+                })
+            ],
+            external: builtins
+        };
+        const bundle = await rollup.rollup(inputOptions);
+        const outputOptions = <rollup.RollupOptions>{
+            file: output,
+            format: "esm"
+        };
+        await bundle.write(outputOptions);
+        await bundle.close();
+    }
+}

package/rollup/overrides/sap/base/config.js

@@ -0,0 +1,59 @@
+/*!
+* ${copyright}
+*/
+sap.ui.define([
+], (
+) => {
+    "use strict";
+
+    /**
+     * The base Configuration.
+     *
+     * @author SAP SE
+     * @version ${version}
+     * @private
+     * @ui5-restricted sap.ui.core, sap.fl, sap.ui.intergration, sap.ui.export
+     * @alias module:sap/base/config
+     * @borrows module:sap/base/config/_Configuration.get as get
+     * @borrows module:sap/base/config/_Configuration.Type as Type
+     * @namespace
+     */
+
+    const _Configuration = { _: {} };
+
+    const internalConfig = new Map();
+
+    /**
+     * Returns a writable base configuration instance
+     * @returns {module:sap/base/config} The writable base configuration
+     * @private
+     * @ui5-restricted sap.ui.core, sap.fl
+     */
+    _Configuration.getWritableInstance = () => {
+        return {
+            get(obj) {
+                internalConfig.get(obj.name);
+            },
+            set(name, obj) {
+                internalConfig.set(name, obj);
+            }
+        }
+    };
+
+    /**
+     * Attaches the <code>fnFunction</code> event handler to the {@link #event:invalidated invalidated} event
+     *
+     * @param {function} fnFunction The function to be called when the event occurs
+     * @private
+     */
+    function attachInvalidated() {
+    }
+    _Configuration._.attachInvalidated = attachInvalidated;
+
+    const origInvalidate = _Configuration._.invalidate;
+    _Configuration._.invalidate = () => {
+        origInvalidate();
+    };
+
+    return _Configuration;
+});

package/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/rollup/overrides/sap/ui/performance/Measurement.js

@@ -0,0 +1,4 @@
+export default class PerfMeasurement {
+	static average() {}
+	static end() {}
+}

package/rollup/project/package.json

@@ -0,0 +1,4 @@
+{
+    "name": "rollup",
+    "version": "1.0.0"
+}

package/rollup/project/ui5.yaml

@@ -0,0 +1,13 @@
+---
+specVersion: "2.2"
+type: application
+metadata:
+  name: rollup
+  allowSapInternal: true
+framework:
+  name: SAPUI5
+  version: 0.0.0
+  libraries:
+    - name: sap.ui.fl
+    - name: sap.suite.ui.generic.template
+    - name: sap.fe.core

package/rollup/project/webapp/manifest.json

@@ -0,0 +1,5 @@
+{
+    "sap.app": {
+        "id": "rollup"
+    }
+}

package/rollup/rollup.ts

@@ -0,0 +1,133 @@
+import * as fs from "fs";
+import * as path from "path";
+import * as semver from "semver";
+import * as yaml from "js-yaml";
+import Bundler from "./bundler.js";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+
+import * as resourceFactory from "@ui5/fs/resourceFactory";
+import { graphFromPackageDependencies } from "@ui5/project/graph";
+import { getLogger } from "@ui5/logger";
+
+const log = getLogger("rollup-plugin-ui5-resolve-task-adaptation");
+const __dirname = dirname(fileURLToPath(import.meta.url));
+
+const projectPaths = [
+    path.resolve(__dirname, "project")
+];
+const LATEST_VERSION_PLACEHOLDER = "0.0.0";
+
+export default class Builder {
+
+    static async getProjectInfo(projectPaths: string[]) {
+        for (const cwd of projectPaths) {
+            try {
+                const options = <any>{
+                    cwd
+                };
+                const version = this.validateProjectSettings(cwd);
+                if (version === LATEST_VERSION_PLACEHOLDER) {
+                    options.versionOverride = "latest";
+                }
+                return await graphFromPackageDependencies(options);
+            } catch (error: any) {
+                log.info(`${error.message}`);
+            }
+        }
+    }
+
+    static validateProjectSettings(projectPath: string): string {
+        const FRAMEWORK_TYPES = ["OpenUI5", "SAPUI5"];
+        const content = fs.readFileSync(path.join(projectPath, "ui5.yaml"), { encoding: "utf-8" });
+        const yamlJson = <any>yaml.load(content);
+        const framework = yamlJson["framework"];
+        if (!FRAMEWORK_TYPES.includes(framework.name)) {
+            throw new Error(`UI5 framework name is incorrect, possible values: ${FRAMEWORK_TYPES.join(" or ")}`);
+        }
+        if (!semver.valid(framework.version)) {
+            throw new Error(`UI5 framework version should correspond semantic version standard, e.g: 1.85.2`);
+        }
+        return framework.version;
+    }
+
+    static getBundledUI5Version(destination: string) {
+        const bundleFilePath = path.join(process.cwd(), destination);
+        if (fs.existsSync(bundleFilePath)) {
+            const bundle = fs.readFileSync(bundleFilePath, { encoding: "utf-8" });
+            const version = bundle.substring(2, bundle.indexOf("\n"));
+            return semver.coerce(version);
+        }
+    }
+
+    static async getResources(namespaces: Map<string, string[]>, projectGraph: any): Promise<Map<string, any>> {
+        const fsBasePaths = new Set<string>();
+        const adapters = new Map<string, any>();
+        for (const project of [...projectGraph.getProjects("rollup")]) {
+            const fsBasePath = project.getSourcePath();
+            if (!fsBasePaths.has(fsBasePath)) {
+                adapters.set(project.getNamespace(), resourceFactory.createReader({
+                    fsBasePath,
+                    virBasePath: "/resources/"
+                }));
+                fsBasePaths.add(fsBasePath);
+            }
+        }
+
+        const resources = new Map<string, any>();
+        for (const [namespace, adapter] of adapters.entries()) {
+            const patterns = namespaces.get(namespace);
+            if (patterns) {
+                for (const pattern of patterns) {
+                    const result = await adapter.byGlob(pattern) as any[];
+                    result.forEach(resource => resources.set(resource.getPath(), resource));
+                }
+            }
+        }
+
+        return resources;
+    }
+
+    static copyTypeDefinition() {
+        fs.copyFileSync(path.join(__dirname, "bundle.d.ts"), path.join(process.cwd(), "dist", "bundle.d.ts"))
+    }
+
+    static async run(): Promise<void> {
+        const project = await this.getProjectInfo(projectPaths);
+        if (!project) {
+            throw new Error("ui5.yaml is not found or incorrect");
+        }
+        const namespaces = new Map([
+            ["sap/fe/core", [
+                "/resources/sap/fe/core/**"
+            ]],
+            ["sap/ui/fl", [
+                "/resources/sap/ui/fl/**"
+            ]],
+            ["sap/ui/core", [
+                "/resources/ui5loader-autoconfig.js",
+                "/resources/sap/base/**",
+                "/resources/sap/ui/{base,thirdparty,model,util}/**"
+            ]],
+            ["sap/suite/ui/generic/template", [
+                "/resources/sap/suite/ui/generic/template/**"
+            ]]
+        ]);
+        const resources = await this.getResources(namespaces, project);
+        await Bundler.run(
+            resources,
+            "bundleDefinition.js",
+            "./dist/bundle.js",
+            [
+                "sap/ui/performance/Measurement"
+            ]
+        );
+        this.copyTypeDefinition();
+    }
+}
+
+if (process.argv.length === 2) {
+    const start = Date.now();
+    await Builder.run();
+    log.info(`Bundled in ${Date.now() - start} ms`);
+}