@ui5/task-adaptation 1.2.0 → 1.3.1

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.2.0...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.3.1...HEAD).
+
+<a name="v1.3.1"></a>
+## [v1.3.1] - 2024-06-04
+
+<a name="v1.3.0"></a>
+## [v1.3.0] - 2024-03-22
 
 <a name="v1.2.0"></a>
 ## [v1.2.0] - 2024-03-05
@@ -85,6 +91,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.3.1]: https://github.com/SAP/ui5-task-adaptation/compare/v1.3.0...v1.3.1
+[v1.3.0]: https://github.com/SAP/ui5-task-adaptation/compare/v1.2.0...v1.3.0
 [v1.2.0]: https://github.com/SAP/ui5-task-adaptation/compare/v1.1.3...v1.2.0
 [v1.1.3]: https://github.com/SAP/ui5-task-adaptation/compare/v1.1.2...v1.1.3
 [v1.1.2]: https://github.com/SAP/ui5-task-adaptation/compare/v1.1.1...v1.1.2

package/eslint.config.js

@@ -0,0 +1,52 @@
+// @ts-check
+
+import * as eslintimport from "eslint-plugin-import";
+
+import eslint from "@eslint/js";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+    eslint.configs.recommended,
+    ...tseslint.configs.recommendedTypeChecked,
+    {
+        languageOptions: {
+            parserOptions: {
+                project: true,
+                tsconfigRootDir: import.meta.dirname,
+            },
+        },
+        plugins: {
+            import: eslintimport
+        },
+        rules: {
+            "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/no-unsafe-call": "off",
+            "@typescript-eslint/no-unsafe-member-access": "off",
+            "@typescript-eslint/no-unsafe-assignment": "off",
+            "@typescript-eslint/no-unsafe-return": "off",
+            "@typescript-eslint/no-unsafe-argument": "off",
+            "@typescript-eslint/no-redundant-type-constituents": "off",
+            "@typescript-eslint/ban-ts-comment": "off",
+            "@typescript-eslint/no-base-to-string": "off",
+            "@typescript-eslint/restrict-template-expressions": "off",
+            "@typescript-eslint/unbound-method": "off",
+            "@typescript-eslint/no-unnecessary-type-assertion": "off",
+            "@typescript-eslint/require-await": "off",
+            "@typescript-eslint/no-floating-promises": "off",
+            "@typescript-eslint/ban-types": "off",
+            "@typescript-eslint/await-thenable": "off",
+            "no-constant-condition": "off",
+            "no-useless-escape": "off",
+            "no-unsafe-optional-chaining": "off",
+            "no-extra-semi": "off",
+            "prefer-const": "off",
+            "import/extensions": [
+                "error",
+                "ignorePackages",
+                {
+                    "js": "always"
+                }
+            ]
+        }
+    }
+);

package/package.json

@@ -1,21 +1,21 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.2.0",
+    "version": "1.3.1",
     "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 build && npm run coverage",
-        "dev": "mocha --no-timeouts -r ts-node/register 'test/**/*.spec.ts'",
-        "perf": "mocha --no-timeouts -r ts-node/register 'test/**/*.perf.ts'",
-        "coverage": "nyc mocha -r ts-node/register 'test/**/*.spec.ts'",
-        "coverage-verbose": "nyc --reporter=html --reporter=text mocha -r ts-node/register 'test/**/*.spec.ts'",
-        "preversion": "npm test",
+        "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",
+        "preversion": "",
         "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": "npx ts-node scripts/rollup.ts",
-        "build": "npm run rollup && rimraf dist/resources && tsc -p ./",
-        "download-metadata": "npx ts-node scripts/metadataDownloadHelper.ts"
+        "rollup": "tsx scripts/rollup.ts",
+        "build": "npm run rollup && tsc -p ./",
+        "download-metadata": "tsx scripts/metadataDownloadHelper.ts"
     },
     "repository": {
         "type": "git",
@@ -33,29 +33,21 @@
     "author": "SAP SE",
     "license": "Apache-2.0",
     "dependencies": {
-        "@buxlabs/amd-to-es6": "^0.16.1",
-        "@rollup/plugin-node-resolve": "^13.0.4",
-        "@sap/cf-tools": "^2.0.1",
-        "@ui5/fs": "^2.0.6",
-        "@ui5/logger": "^2.0.1",
-        "@ui5/project": "^2.6.0",
+        "@sap/cf-tools": "^3.2.0",
+        "@ui5/fs": "^3.0.5",
+        "@ui5/logger": "^3.0.0",
         "adm-zip": "^0.5.5",
-        "amdextract": "^3.0.0",
         "axios": "^1.6.2",
-        "builtin-modules": "^3.2.0",
         "crc": "^4.3.2",
         "dotenv": "^16.0.3",
-        "glob": "^10.3.10",
-        "js-yaml": "^4.1.0",
         "jsdom": "^23.0.1",
-        "rimraf": "^5.0.5",
-        "rollup": "^2.56.3",
-        "semver": "^7.3.5",
         "temp-dir": "^2.0.0",
         "xml-js": "^1.6.11"
     },
     "devDependencies": {
+        "@buxlabs/amd-to-es6": "^0.16.1",
         "@istanbuljs/nyc-config-typescript": "^1.0.1",
+        "@rollup/plugin-node-resolve": "^15.2.3",
         "@types/adm-zip": "^0.4.34",
         "@types/chai": "^4.2.21",
         "@types/chai-as-promised": "^7.1.4",
@@ -63,22 +55,36 @@
         "@types/jsdom": "^21.1.6",
         "@types/lodash": "^4.14.196",
         "@types/mocha": "^9.1.0",
-        "@types/rimraf": "^4.0.5",
         "@types/semver": "^7.3.8",
         "@types/sinon": "^10.0.16",
+        "@ui5/project": "^3.9.0",
+        "amdextract": "^3.0.0",
+        "builtin-modules": "^3.2.0",
+        "c8": "^9.1.0",
         "chai": "^4.3.4",
         "chai-as-promised": "^7.1.1",
         "chalk": "^4.1.2",
+        "eslint": "^8.57.0",
+        "eslint-plugin-import": "^2.29.1",
+        "esmock": "^2.6.3",
+        "glob": "^10.3.10",
+        "js-yaml": "^4.1.0",
+        "lodash": "^4.17.21",
         "minimatch": "^9.0.3",
-        "mocha": "^9.2.0",
+        "mocha": "^10.2.0",
         "mock-require": "^3.0.3",
         "nyc": "^15.1.0",
-        "sinon": "^15.2.0",
+        "rollup": "^4.9.6",
+        "semver": "^7.3.5",
+        "sinon": "^17.0.1",
         "source-map-support": "^0.5.19",
-        "ts-node": "^10.4.0",
-        "typescript": "^4.3.5"
+        "tsx": "^4.7.1",
+        "typescript": "^5.4.2",
+        "typescript-eslint": "^7.2.0"
     },
-    "nyc": {
+    "c8": {
+        "src": "./src",
+        "all": true,
         "reporter": [
             "lcov",
             "text",
@@ -95,33 +101,17 @@
             "src/model/types.ts",
             "src/util/requestUtil.ts",
             "scripts/**/*.js",
-            "scripts/git/octokitUtil.ts"
+            "scripts/git/octokitUtil.ts",
+            "*/**/*.d.ts",
+            "src/annotations/comparator/diffCase.ts",
+            "src/annotations/transformers/transformer.ts"
         ],
         "check-coverage": true,
         "statements": 85,
         "branches": 70,
         "functions": 90,
-        "lines": 85,
-        "watermarks": {
-            "statements": [
-                70,
-                90
-            ],
-            "branches": [
-                70,
-                90
-            ],
-            "functions": [
-                70,
-                90
-            ],
-            "lines": [
-                70,
-                90
-            ]
-        },
-        "cache": true,
-        "all": true
+        "lines": 85
     },
-    "types": "dist/index.d.ts"
+    "types": "dist/index.d.ts",
+    "type": "module"
 }

package/scripts/metadataDownloadHelper.ts

@@ -1,7 +1,8 @@
 import * as dotenv from "dotenv";
 import * as fs from "fs/promises";
+
 import { Agent } from "https";
-import RequestUtil from "../src/util/requestUtil";
+import RequestUtil from "../src/util/requestUtil.js";
 
 dotenv.config();
 const httpsAgent = new Agent({ rejectUnauthorized: false });
@@ -75,13 +76,13 @@ const hostArgIndex = args.findIndex(arg => arg.startsWith('--host='));
 
 // If the `--host=` argument is found
 if (hostArgIndex !== -1) {
-  // Extract the value of the `--host=` argument
-  const hostArg = args[hostArgIndex];
-  let host = hostArg.split('=')[1];
-  host = host.endsWith("/") ? host.substring(0, host.lastIndexOf("/")) : host;
+    // Extract the value of the `--host=` argument
+    const hostArg = args[hostArgIndex];
+    let host = hostArg.split('=')[1];
+    host = host.endsWith("/") ? host.substring(0, host.lastIndexOf("/")) : host;
 
-  // Use the `host` variable as needed
-  MetadataDownloadHelper.fetchAllUrls(host);
+    // Use the `host` variable as needed
+    MetadataDownloadHelper.fetchAllUrls(host);
 } else {
     console.info("Please provide missing host parameter");
 }

package/scripts/rollup/bundle.d.ts

@@ -0,0 +1,25 @@
+export declare const RegistrationBuild: () => void;
+
+export declare class Applier {
+    static applyChanges(manifest: any, changes: Change[], strategy: any): Promise<void>;
+}
+
+export declare class Change {
+    constructor(change: any);
+    getLayer(): string;
+    _oDefinition: any;
+}
+
+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/scripts/rollup/bundleDefinition.js

@@ -1,11 +1,21 @@
+//Flex
 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";
+import V2MetadataConverter from "sap/ui/model/odata/v4/lib/_V2MetadataConverter";
+import V4MetadataConverter from "sap/ui/model/odata/v4/lib/_V4MetadataConverter";
 
 export {
+    //Flex
     Applier,
     ApplyUtil,
     Change,
-    RegistrationBuild
+    RegistrationBuild,
+    //OData
+    URI,
+    V4MetadataConverter,
+    V2MetadataConverter
 };

package/scripts/{bundler.ts → rollup/bundler.ts}

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

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

@@ -0,0 +1,10 @@
+export default class config {
+    static get Type() {
+        return {
+            String: "string"
+        }
+    }
+    static get({ name }) {
+        return name === "sapUiLogLevel" ? "Error" : undefined;
+    }
+}

package/scripts/rollup/project/package.json

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

package/scripts/rollup/project/ui5.yaml

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

package/scripts/rollup/ui5Resolve.ts

@@ -1,13 +1,15 @@
 import * as crypto from "crypto";
 import * as fs from "fs";
 import * as path from "path";
-import * as stream from "stream";
 
-import { promisify } from "util";
+//@ts-ignore
+import convertAMDtoES6 from "@buxlabs/amd-to-es6";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
+import { getLogger } from "@ui5/logger";
 
-const convertAMDtoES6 = require("@buxlabs/amd-to-es6");
-const log = require("@ui5/logger").getLogger("rollup-plugin-ui5-resolve-task-adaptation");
-const { resourceFactory } = require("@ui5/fs");
+const log = getLogger("rollup-plugin-ui5-resolve-task-adaptation");
+const __dirname = dirname(fileURLToPath(import.meta.url));
 
 
 interface TransformCase {
@@ -29,35 +31,12 @@ class UriTransformCase implements TransformCase {
 
 export default function (options: any) {
 
-    let dependencies: any;
-
     const skipTransformation = (id: string) => !options.skipTransformation?.includes(id);
 
     return {
 
         name: "ui5-resolve",
 
-        buildStart: async (_: any) => {
-
-            dependencies = resourceFactory.createCollectionsForTree(options.project, {}).dependencies;
-
-            const pipe = promisify(stream.pipeline);
-            const resources: any[] = await Promise.all(options.assets.map((asset: string) => dependencies.byGlob(asset)));
-            const writePromises = [].concat(...resources).map((resource: any) => {
-                const file = `./dist${resource.getPath()}`;
-                const folder = path.dirname(file);
-                if (!fs.existsSync(folder)) {
-                    fs.mkdirSync(folder, { recursive: true });
-                }
-                if (fs.existsSync(file)) {
-                    fs.unlinkSync(file);
-                }
-                return pipe(resource.getStream(), fs.createWriteStream(file));
-            });
-            await Promise.all(writePromises);
-        },
-
-
         /*
          * Right before writing result to dist
          */
@@ -79,13 +58,9 @@ export default function (options: any) {
         load: async (id: string) => {
             log.verbose(`load: ${id}`);
 
-            if (!dependencies) {
-                dependencies = resourceFactory.createCollectionsForTree(options.project, {}).dependencies;
-            }
-
             const localFile = path.join(__dirname, id);
             if (fs.existsSync(localFile)) {
-                log.info(`Using local file "${id}"`);
+                log.info(`Bundle definition "${id}"`);
                 return fs.readFileSync(localFile, {
                     encoding: "utf8"
                 });
@@ -93,12 +68,13 @@ export default function (options: any) {
 
             const localOverride = path.resolve(__dirname, "overrides", id + ".js");
             if (fs.existsSync(localOverride)) {
-                log.info(`Using local override for "${id}"`);
+                log.info(`Override with "${id}"`);
                 return fs.readFileSync(localOverride, { encoding: "utf8" });
             }
-
-            const resource = await dependencies.byPath(`/resources/${id}.js`);
-            return resource.getString();
+            const filepath = `/resources/${id}.js`;
+            if (options.resources.has(filepath)) {
+                return await options.resources.get(filepath).getString();
+            }
         },
 
 
@@ -160,4 +136,4 @@ function replaceRequireAsync(code: string) {
 
 function replaceRequireAsyncWith(code: string, requireAsyncSearchKeyword: string, inserts: string[]) {
     return code.replace(requireAsyncSearchKeyword, inserts.join(",\n\t"));
-}
+}

package/scripts/rollup.ts

@@ -2,10 +2,16 @@ 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";
+import Bundler from "./rollup/bundler.js";
+import { dirname } from "node:path";
+import { fileURLToPath } from "node:url";
 
-const { normalizer } = require("@ui5/project");
-const log = require("@ui5/logger").getLogger("rollup-plugin-ui5-resolve-task-adaptation");
+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, "rollup", "project")
@@ -22,11 +28,9 @@ export default class Builder {
                 };
                 const version = this.validateProjectSettings(cwd);
                 if (version === LATEST_VERSION_PLACEHOLDER) {
-                    options.frameworkOptions = {
-                        versionOverride: "latest"
-                    }
+                    options.versionOverride = "latest";
                 }
-                return normalizer.generateProjectTree(options);
+                return await graphFromPackageDependencies(options);
             } catch (error: any) {
                 log.info(`${error.message}`);
             }
@@ -56,35 +60,75 @@ export default class Builder {
         }
     }
 
+    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, "rollup", "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}/**"
+            ]],
+            ["sap/suite/ui/generic/template", [
+                "/resources/sap/suite/ui/generic/template/**"
+            ]]
+        ]);
+        const resources = await this.getResources(namespaces, project);
         await Bundler.run(
-            project,
+            resources,
             "bundleDefinition.js",
             "./dist/bundle.js",
             [
-                "/resources/sap/ui/fl/**",
-                "/resources/sap/suite/ui/generic/template/**"
-            ]);
-        await Bundler.run(
-            project,
-            "bundleDefinition-odata.js",
-            "./dist/bundle-odata.js",
-            [
-                "/resources/sap/ui/model/**",
-                "sap/ui/util/XMLHelper",
-                "sap/ui/core/Core"
-            ],
-            [
-                "sap/ui/performance/Measurement"
+                "sap/ui/performance/Measurement",
+                "sap/base/config.js"
             ]
         );
+        this.copyTypeDefinition();
     }
 }
 
 if (process.argv.length === 2) {
-    Builder.run();
+    const start = Date.now();
+    await Builder.run();
+    log.info(`Bundled in ${Date.now() - start} ms`);
 }

package/types/ui5.d.ts

@@ -0,0 +1,44 @@
+declare module "@ui5/logger" {
+    export function getLogger(name: string): any;
+}
+
+declare module "@ui5/fs/resourceFactory" {
+    export function createResource(options: any): any;
+    export function createReader(options: any): any;
+    export function createAdapter(options: any): any;
+    export function createWorkspace(options: any): any;
+    export function createCollectionsForTree(project: any, options: any): any;
+}
+
+declare class Resource {
+    getPath(): string;
+    clone(): Resource;
+    setPath(path: string): void;
+    getString(): Promise<string>;
+    setString(string: string): void;
+}
+
+declare module "@ui5/fs/Resource" {
+    export function getPath(): string;
+    export function clone(): Resource;
+    export function setPath(path: string): void;
+    export function getString(): Promise<string>;
+    export function setString(string: string): void;
+}
+
+declare module "@ui5/project/graph" {
+    export function graphFromPackageDependencies(options: any): any;
+}
+
+declare module "@ui5/project/build/helpers/BuildContext" {
+    export default class BuildContext {
+        constructor(projectGraph: any, options: any);
+        createProjectContext(options: any): any;
+    }
+}
+
+declare module "@ui5/project/build/helpers/TaskUtil" {
+    export default class TaskUtil {
+        constructor(options: any);
+    }
+}