@ui5/task-adaptation 1.6.4 → 1.6.5-rc.2

package/dist/repositories/{abapRepoManager.js → abapRepository.js}

@@ -1,7 +1,14 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
 import AbapProvider from "./abapProvider.js";
 import { getLogger } from "@ui5/logger";
 import { unzipZipEntries } from "../util/zipUtil.js";
-const log = getLogger("@ui5/task-adaptation::AbapRepoManager");
+import { cached } from "../cache/cacheHolder.js";
+const log = getLogger("@ui5/task-adaptation::AbapRepository");
 const REQUEST_OPTIONS_XML = {
     responseType: "text",
     headers: {
@@ -13,13 +20,16 @@ const REQUEST_OPTIONS_JSON = {
         "Accept": "application/json"
     }
 };
-export default class AbapRepoManager {
+export default class AbapRepository {
     configuration;
     abapProvider;
     constructor(configuration, abapProvider) {
         this.configuration = configuration;
         this.abapProvider = abapProvider ? abapProvider : new AbapProvider();
     }
+    fetchReuseLib(_libName, _cachebusterToken, _lib) {
+        throw new Error("Preview is not available on SAP S/4HANA On-Premise or Cloud Systems. Please create a ticket on CA-UI5-FL-ADP-BAS component.");
+    }
     async getAppVariantIdHierarchy(id) {
         const provider = await this.abapProvider.get(this.configuration);
         const lrep = provider.getLayeredRepository();
@@ -68,7 +78,7 @@ export default class AbapRepoManager {
             id
         };
     }
-    async fetch(repoName) {
+    async fetch(repoName, _cachebusterToken) {
         const encodedRepoName = encodeURIComponent(repoName);
         const provider = await this.abapProvider.get(this.configuration);
         const ui5Repo = provider.getUi5AbapRepository();
@@ -87,4 +97,7 @@ export default class AbapRepoManager {
         throw new Error(`App '${repoName}' doesn't contain files`);
     }
 }
-//# sourceMappingURL=abapRepoManager.js.map
+__decorate([
+    cached()
+], AbapRepository.prototype, "fetch", null);
+//# sourceMappingURL=abapRepository.js.map

package/dist/repositories/html5Repository.d.ts

@@ -0,0 +1,19 @@
+import { IConfiguration, IReuseLibInfo } from "./../model/types.js";
+import IRepository from "./repository.js";
+import { IAppVariantIdHierarchyItem } from "../model/appVariantIdHierarchyItem.js";
+export default class HTML5Repository implements IRepository {
+    private configuration;
+    private validator;
+    constructor(configuration: IConfiguration);
+    getAppVariantIdHierarchy(appId: string): Promise<IAppVariantIdHierarchyItem[]>;
+    fetch(_repoName: string, _cachebusterToken: string): Promise<Map<string, string>>;
+    fetchReuseLib(_libName: string, _cachebusterToken: string, lib: IReuseLibInfo): Promise<Map<string, string>>;
+    getMetadata(): Promise<any>;
+    private getHtml5RepoInfo;
+    private getHTML5Credentials;
+    private getToken;
+    private requestMetadata;
+    private getAppZipEntries;
+    private download;
+    downloadAnnotationFile(_uri: string): Promise<Map<string, string>>;
+}

package/dist/repositories/{html5RepoManager.js → html5Repository.js}

@@ -1,24 +1,42 @@
-import CFUtil from "./../util/cfUtil.js";
-import RequestUtil from "./../util/requestUtil.js";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import CFUtil from "../util/cfUtil.js";
+import RequestUtil from "../util/requestUtil.js";
 import { getLogger } from "@ui5/logger";
-import { unzipZipEntries } from "./../util/zipUtil.js";
-const log = getLogger("@ui5/task-adaptation::HTML5RepoManager");
-export default class HTML5RepoManager {
-    static async getBaseAppFiles(configuration) {
-        const { token, baseUri } = await this.getHtml5RepoInfo(configuration);
-        const app = {
-            appName: configuration.appName,
-            appVersion: configuration.appVersion,
-            appHostId: configuration.appHostId
-        };
-        return this.getAppZipEntries(app, baseUri, token);
+import { unzipZipEntries } from "../util/zipUtil.js";
+import { cached } from "../cache/cacheHolder.js";
+import CFValidator from "../util/validator/cfValidator.js";
+const log = getLogger("@ui5/task-adaptation::HTML5Repository");
+export default class HTML5Repository {
+    configuration;
+    validator = new CFValidator();
+    constructor(configuration) {
+        this.configuration = configuration;
+        this.validator.validateConfiguration(configuration);
+    }
+    async getAppVariantIdHierarchy(appId) {
+        const metadata = await this.getMetadata();
+        return [{
+                repoName: this.configuration.appName,
+                appVariantId: appId,
+                cachebusterToken: metadata.changedOn
+            }];
     }
-    static async getMetadata(configuration) {
-        const { token, baseUri } = await this.getHtml5RepoInfo(configuration);
-        return this.requestMetadata(configuration, baseUri, token);
+    async fetch(_repoName, _cachebusterToken) {
+        const { token, baseUri } = await this.getHtml5RepoInfo();
+        const appData = {
+            appName: this.configuration.appName,
+            appVersion: this.configuration.appVersion,
+            appHostId: this.configuration.appHostId
+        };
+        return this.getAppZipEntries(appData, baseUri, token);
     }
-    static async getReuseLibFiles(configuration, lib) {
-        const { token, baseUri } = await this.getHtml5RepoInfo(configuration);
+    async fetchReuseLib(_libName, _cachebusterToken, lib) {
+        const { token, baseUri } = await this.getHtml5RepoInfo();
         const libAppData = {
             appName: lib.html5AppName,
             appVersion: lib.html5AppVersion,
@@ -26,8 +44,12 @@ export default class HTML5RepoManager {
         };
         return this.getAppZipEntries(libAppData, baseUri, token);
     }
-    static async getHtml5RepoInfo(configuration) {
-        const spaceGuid = await CFUtil.getSpaceGuid(configuration?.space);
+    async getMetadata() {
+        const { token, baseUri } = await this.getHtml5RepoInfo();
+        return this.requestMetadata(baseUri, token);
+    }
+    async getHtml5RepoInfo() {
+        const spaceGuid = await CFUtil.getSpaceGuid(this.configuration?.space);
         const credentials = await this.getHTML5Credentials(spaceGuid);
         const token = await this.getToken(credentials);
         if (!token || token.length === 0) {
@@ -41,7 +63,7 @@ export default class HTML5RepoManager {
             baseUri: credentials.uri
         };
     }
-    static async getHTML5Credentials(spaceGuid) {
+    async getHTML5Credentials(spaceGuid) {
         log.verbose("Getting HTML5 Repo Runtime credentials from space " + spaceGuid);
         const PLAN_NAME = "app-runtime";
         const SERVIСE_INSTANCE_NAME = "html5-apps-repo-runtime";
@@ -60,7 +82,7 @@ export default class HTML5RepoManager {
         const serviceKeys = await CFUtil.getServiceInstanceKeys(getParams, createParams);
         return serviceKeys.credentials;
     }
-    static async getToken({ uaa }) {
+    async getToken({ uaa }) {
         log.verbose("Getting HTML5 Repo token");
         const auth = Buffer.from(uaa.clientid + ":" + uaa.clientsecret);
         const options = {
@@ -72,8 +94,8 @@ export default class HTML5RepoManager {
         const uri = `${uaa.url}/oauth/token?grant_type=client_credentials`;
         return RequestUtil.get(uri, options).then((json) => json["access_token"]);
     }
-    static async requestMetadata(options, html5RepoBaseUri, token) {
-        const { appHostId, appName, appVersion } = options;
+    async requestMetadata(html5RepoBaseUri, token) {
+        const { appHostId, appName, appVersion } = this.configuration;
         const uri = `${html5RepoBaseUri}/applications/metadata/`;
         const requestOptions = {
             headers: {
@@ -85,12 +107,12 @@ export default class HTML5RepoManager {
         const metadata = await RequestUtil.get(uri, requestOptions);
         return metadata.find((item) => item.appHostId === appHostId && item.applicationName === appName && item.applicationVersion === appVersion);
     }
-    static async getAppZipEntries(app, html5RepoBaseUri, token) {
+    async getAppZipEntries(app, html5RepoBaseUri, token) {
         const uri = `${html5RepoBaseUri}/applications/content/${app.appName}-${app.appVersion}/`;
         const zip = await this.download(token, app.appHostId, uri);
         return unzipZipEntries(zip);
     }
-    static async download(token, appHostId, uri) {
+    async download(token, appHostId, uri) {
         if (!token) {
             throw new Error("HTML5 token is undefined");
         }
@@ -103,5 +125,15 @@ export default class HTML5RepoManager {
             }
         });
     }
+    downloadAnnotationFile(_uri) {
+        log.verbose("No annotation processing in CF");
+        return Promise.resolve(new Map());
+    }
 }
-//# sourceMappingURL=html5RepoManager.js.map
+__decorate([
+    cached()
+], HTML5Repository.prototype, "fetch", null);
+__decorate([
+    cached()
+], HTML5Repository.prototype, "fetchReuseLib", null);
+//# sourceMappingURL=html5Repository.js.map

package/dist/repositories/localRepository.d.ts

@@ -0,0 +1,16 @@
+import { IAppVariantIdHierarchyItem } from "../model/appVariantIdHierarchyItem.js";
+import { IConfiguration } from "../model/configuration.js";
+import { IReuseLibInfo } from "../model/types.js";
+import IRepository from "./repository.js";
+export default class LocalRepository implements IRepository {
+    private configuration;
+    constructor(configuration: IConfiguration);
+    downloadAnnotationFile(_uri: string): Promise<Map<string, string>>;
+    getAppVariantIdHierarchy(appId: string): Promise<IAppVariantIdHierarchyItem[]>;
+    fetch(appId: string, cachebusterToken: string): Promise<Map<string, string>>;
+    fetchReuseLib(libName: string, cachebusterToken: string, _lib: IReuseLibInfo): Promise<Map<string, string>>;
+    private collectAppVariantIdHierarchyItems;
+    private getExistingManifestPath;
+    private readFilesInBaseAppDir;
+    private getLocalFilesDirectory;
+}

package/dist/repositories/localRepository.js

@@ -0,0 +1,67 @@
+import { getLogger } from "@ui5/logger";
+import path from "node:path";
+import fs from "node:fs/promises";
+import FsUtil from "../util/fsUtil.js";
+const log = getLogger("@ui5/task-adaptation::LocalRepository");
+export default class LocalRepository {
+    configuration;
+    constructor(configuration) {
+        this.configuration = configuration;
+    }
+    async downloadAnnotationFile(_uri) {
+        log.verbose("Downloading annotation files is not supported in LocalRepository.");
+        return new Map();
+    }
+    async getAppVariantIdHierarchy(appId) {
+        const items = [];
+        await this.collectAppVariantIdHierarchyItems(appId, items);
+        return items;
+    }
+    fetch(appId, cachebusterToken) {
+        return this.readFilesInBaseAppDir(appId, cachebusterToken);
+    }
+    fetchReuseLib(libName, cachebusterToken, _lib) {
+        return this.readFilesInBaseAppDir(libName, cachebusterToken);
+    }
+    async collectAppVariantIdHierarchyItems(appId, items) {
+        const appDir = this.getLocalFilesDirectory(appId);
+        const filenames = [
+            ["manifest.json"],
+            ["manifest.appdescr_variant"],
+            ["webapp", "manifest.json"],
+            ["webapp", "manifest.appdescr_variant"],
+        ];
+        const filepaths = filenames.map((filename) => path.join(appDir, ...filename));
+        const existingManifestPath = await this.getExistingManifestPath(filepaths);
+        items.push({
+            appVariantId: appId,
+            repoName: appId,
+            cachebusterToken: path.dirname(existingManifestPath)
+        });
+        if (existingManifestPath.endsWith("manifest.appdescr_variant")) {
+            const manifestContent = await fs.readFile(existingManifestPath, "utf-8");
+            const manifest = JSON.parse(manifestContent);
+            await this.collectAppVariantIdHierarchyItems(manifest.reference, items);
+        }
+    }
+    async getExistingManifestPath(filePaths) {
+        const existenceChecks = await Promise.all(filePaths.map((filePath) => FsUtil.exists(filePath)));
+        const existingIndex = existenceChecks.findIndex((exists) => exists);
+        if (existingIndex !== -1) {
+            return filePaths[existingIndex];
+        }
+        throw new Error(`None of the paths exist: '${filePaths.join("', '")}'.`);
+    }
+    readFilesInBaseAppDir(_appId, cachebusterToken) {
+        log.verbose(`Fetching base app files from local directory: ${cachebusterToken}`);
+        return FsUtil.readFilesRecursively(cachebusterToken);
+    }
+    getLocalFilesDirectory(appId) {
+        const adpDirConfigured = process.env.ADP_BUILDER_DIR || this.configuration.adpDir;
+        const adpDir = adpDirConfigured
+            ? path.normalize(adpDirConfigured).replace(/\\/g, "/").replace(/\/+$/, "").split("/")
+            : [".."];
+        return path.join(process.cwd(), ...adpDir, appId);
+    }
+}
+//# sourceMappingURL=localRepository.js.map

package/dist/repositories/repository.d.ts

@@ -0,0 +1,8 @@
+import { IAppVariantIdHierarchyItem } from "../model/appVariantIdHierarchyItem.js";
+import { IReuseLibInfo } from "../model/types.js";
+export default interface IRepository {
+    getAppVariantIdHierarchy(appId: string): Promise<IAppVariantIdHierarchyItem[]>;
+    fetch(repoName: string, cachebusterToken: string): Promise<Map<string, string>>;
+    fetchReuseLib(libName: string, cachebusterToken: string, lib: IReuseLibInfo): Promise<Map<string, string>>;
+    downloadAnnotationFile(uri: string): Promise<Map<string, string>>;
+}

package/dist/repositories/repository.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=repository.js.map

package/dist/util/commonUtil.d.ts

@@ -1,6 +1,7 @@
 import { IConfiguration } from "../model/types.js";
 import Language from "../model/language.js";
 export declare function dotToUnderscore(value: string): string;
+export declare function validateConfiguration<T extends object>(options: T, properties: Array<keyof T>): void;
 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 insertInArray<T>(array: T[], index: number, insert: T): void;

package/dist/util/commonUtil.js

@@ -9,6 +9,9 @@ const MANIFEST_CHANGE = "appdescr_";
 export function dotToUnderscore(value) {
     return value.replace(/\./g, "_");
 }
+export function validateConfiguration(options, properties) {
+    validateObject(options, properties, "should be specified in ui5.yaml configuration");
+}
 export function validateObject(options, properties, message) {
     for (const property of properties) {
         if (!options[property]) {

package/dist/util/fsUtil.d.ts

@@ -6,4 +6,6 @@ export default class FsUtil {
      * @returns true if the path exists, false if not
      */
     private static fileExists;
+    static readFilesRecursively(rootDirectory: string): Promise<Map<string, string>>;
+    static exists(filePath: string): Promise<boolean>;
 }

package/dist/util/fsUtil.js

@@ -36,5 +36,39 @@ export default class FsUtil {
             throw e;
         }
     }
+    static async readFilesRecursively(rootDirectory) {
+        const directoriesToScan = [rootDirectory];
+        const fileReadTasks = [];
+        while (directoriesToScan.length > 0) {
+            const currentDirectory = directoriesToScan.pop();
+            if (!currentDirectory) {
+                continue;
+            }
+            const entries = await fs.readdir(currentDirectory, { withFileTypes: true });
+            for (const entry of entries) {
+                const entryPath = path.join(currentDirectory, entry.name);
+                if (entry.isDirectory()) {
+                    directoriesToScan.push(entryPath);
+                }
+                else if (entry.isFile()) {
+                    fileReadTasks.push((async () => {
+                        const relativeFilePath = path.relative(rootDirectory, entryPath);
+                        const content = await fs.readFile(entryPath, "utf-8");
+                        return [relativeFilePath, content];
+                    })());
+                }
+            }
+        }
+        return new Map(await Promise.all(fileReadTasks));
+    }
+    static async exists(filePath) {
+        try {
+            await fs.access(filePath);
+            return true;
+        }
+        catch {
+            return false;
+        }
+    }
 }
 //# sourceMappingURL=fsUtil.js.map

package/dist/util/validator/abapValidator.d.ts

@@ -0,0 +1,8 @@
+import { AbapTarget } from "@sap-ux/system-access";
+import { IAbapTargetMeta, IConfiguration, LandscapeType } from "../../model/configuration.js";
+import IValidator from "./validator.js";
+export default class AbapValidator implements IValidator {
+    type: LandscapeType;
+    validateAndGetAbapTarget(target: AbapTarget & IAbapTargetMeta | undefined, destination: string | undefined): AbapTarget & IAbapTargetMeta;
+    validateConfiguration({ target, destination }: IConfiguration): void;
+}

package/dist/util/validator/abapValidator.js

@@ -0,0 +1,26 @@
+import { validateObject } from "../commonUtil.js";
+import BtpUtils from "@sap-ux/btp-utils";
+import { getLogger } from "@ui5/logger";
+const log = getLogger("@ui5/task-adaptation::AbapValidator");
+export default class AbapValidator {
+    type = "abap";
+    validateAndGetAbapTarget(target, destination) {
+        if (target) {
+            // if target configuration appears, we validate that it should be
+            // either target/destination for BAS or target/url for IDE we're
+            // trying to detect is it destination for BAS or url for IDE
+            const abapTargetProperties = BtpUtils.isAppStudio() ? ["destination"] : ["url"];
+            validateObject(target, abapTargetProperties, "should be specified in ui5.yaml configuration/target");
+            return target;
+        }
+        else if (destination) {
+            log.warn("Destination is deprecated, use target/destination configuration instead");
+            return { destination };
+        }
+        throw new Error("Target should be specified in ui5.yaml configuration to connect the ABAP system");
+    }
+    validateConfiguration({ target, destination }) {
+        this.validateAndGetAbapTarget(target, destination);
+    }
+}
+//# sourceMappingURL=abapValidator.js.map

package/dist/util/validator/cfValidator.d.ts

@@ -0,0 +1,6 @@
+import { IConfiguration, LandscapeType } from "../../model/configuration.js";
+import IValidator from "./validator.js";
+export default class CFValidator implements IValidator {
+    type: LandscapeType;
+    validateConfiguration(configuration: IConfiguration): void;
+}

package/dist/util/validator/cfValidator.js

@@ -0,0 +1,8 @@
+import { validateConfiguration } from "../commonUtil.js";
+export default class CFValidator {
+    type = "cf";
+    validateConfiguration(configuration) {
+        validateConfiguration(configuration, ["appHostId", "appName", "appVersion"]);
+    }
+}
+//# sourceMappingURL=cfValidator.js.map

package/dist/util/validator/validator.d.ts

@@ -0,0 +1,6 @@
+import { IConfiguration, LandscapeType } from "../../model/configuration.js";
+export default interface IValidator {
+    type: LandscapeType;
+    validateConfiguration(configuration: IConfiguration): void;
+}
+export declare function isOneOf<T extends readonly unknown[]>(values: T, value: unknown): value is T[number];

package/dist/util/validator/validator.js

@@ -0,0 +1,4 @@
+export function isOneOf(values, value) {
+    return values.includes(value);
+}
+//# sourceMappingURL=validator.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.6.4",
+    "version": "1.6.5-rc.2",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
@@ -97,25 +97,22 @@
             "text-summary"
         ],
         "exclude": [
-            ".eslintrc.js",
-            "docs/**",
-            "jsdocs/**",
             "coverage/**",
             "test/**",
-            "lib/processors/jsdoc/lib/**",
             "dist/**",
             "src/model/types.ts",
             "src/util/requestUtil.ts",
             "src/util/renamingHandlers/renamingHandler.ts",
             "scripts/**/*.js",
-            "scripts/git/octokitUtil.ts",
             "*/**/*.d.ts",
             "src/annotations/comparator/diffCase.ts",
             "src/annotations/transformers/transformer.ts",
             "src/model/configuration.ts",
             "src/model/appVariantIdHierarchyItem.ts",
             "src/adapters/adapter.ts",
-            "src/adapters/previewAdapter.ts"
+            "src/adapters/previewAdapter.ts",
+            "src/repositories/repository.ts",
+            "src/annotations/annotationManager.ts"
         ],
         "check-coverage": true,
         "statements": 85,