@ui5/task-adaptation 1.6.6 → 1.6.7

package/dist/util/resourceUtil.js

@@ -1,6 +1,31 @@
 import * as resourceFactory from "@ui5/fs/resourceFactory";
 import { posix as path } from "path";
 const UTF8 = "utf8";
+/**
+ * Extensions of files whose contents are processed by the adaptation
+ * pipeline as text. Anything outside this whitelist is treated as binary
+ * (e.g. images, fonts) and is saved to the workspace verbatim by WorkspaceManager.
+ *
+ * Kept in sync with EXTENSIONS_TO_PROCESS in appVariant.ts.
+ */
+export const TEXT_EXTENSIONS = new Set([
+    "js",
+    "json",
+    "xml",
+    "html",
+    "properties",
+    "change",
+    "appdescr_variant",
+    "ctrl_variant",
+    "ctrl_variant_change",
+    "ctrl_variant_management_change",
+    "annotation_change",
+    "variant",
+    "fioriversion",
+    "codeChange",
+    "xmlViewChange",
+    "context",
+]);
 export default class ResourceUtil {
     static getRootFolder(projectNamespace) {
         const newPath = ["/resources"];
@@ -21,7 +46,7 @@ export default class ResourceUtil {
      * 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.
+     * @param files A Map of file paths and their contents as Buffer.
      * @returns A promise that resolves when all files have been written.
      */
     static write(dir, files) {
@@ -30,8 +55,8 @@ export default class ResourceUtil {
             virBasePath: "/"
         });
         const promises = [];
-        files.forEach((string, filename) => {
-            const resource = resourceFactory.createResource({ path: "/" + filename, string });
+        files.forEach((content, filename) => {
+            const resource = ResourceUtil.createResourceFromContent("/" + filename, content);
             promises.push(fsTarget.write(resource));
         });
         return Promise.all(promises);
@@ -40,7 +65,7 @@ export default class ResourceUtil {
      * 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.
+     * @param files A Map of file paths and their contents as Buffer.
      * @returns A promise that resolves when all files have been written.
      */
     static writeInProject(dir, files) {
@@ -53,22 +78,27 @@ export default class ResourceUtil {
      * @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.
+     * @returns A promise that resolves to a Map of file paths and their contents as Buffer.
      */
-    static byGlob(dir, pattern, excludes = []) {
+    static async byGlob(dir, pattern, excludes = []) {
         const adapter = resourceFactory.createAdapter({
             fsBasePath: dir,
             virBasePath: "/",
             excludes
         });
-        return adapter.byGlob(pattern).then((resources) => this.toFileMap(resources));
+        const resources = await adapter.byGlob(pattern);
+        const files = new Map();
+        for (const resource of resources) {
+            files.set(resource.getPath().substring(1), await resource.getBuffer());
+        }
+        return files;
     }
     /*
      * 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.
+     * @returns A promise that resolves to a Map of file paths and their contents as Buffer.
      */
     static byGlobInProject(pattern, excludes = []) {
         return ResourceUtil.byGlob("./", pattern, [
@@ -87,16 +117,18 @@ export default class ResourceUtil {
         resource.setBuffer(Buffer.from(str, UTF8));
     }
     static createResource(filename, projectNamespace, content) {
-        return resourceFactory.createResource({
-            path: this.getResourcePath(projectNamespace, filename),
-            string: content
-        });
+        return ResourceUtil.createResourceFromContent(this.getResourcePath(projectNamespace, filename), content);
+    }
+    static createResourceFromContent(resourcePath, content) {
+        return resourceFactory.createResource(Buffer.isBuffer(content)
+            ? { path: resourcePath, buffer: content }
+            : { path: resourcePath, string: content });
     }
     static async toFileMap(resources, projectNamespace) {
         const files = new Map();
         const rootFolderLength = projectNamespace ? ResourceUtil.getRootFolder(projectNamespace).length : 0;
         for (const resource of resources) {
-            files.set(resource.getPath().substring(rootFolderLength + 1), await ResourceUtil.getString(resource));
+            files.set(resource.getPath().substring(rootFolderLength + 1), await resource.getBuffer());
         }
         return files;
     }

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

@@ -0,0 +1,5 @@
+import { AbapTarget } from "@sap-ux/system-access";
+import { IAbapTargetMeta } from "../../model/configuration.js";
+export default class AbapConnectionValidator {
+    validateAndGetAbapTarget(target: AbapTarget & IAbapTargetMeta | undefined, destination: string | undefined): AbapTarget & IAbapTargetMeta;
+}

package/dist/util/validator/abapConnectionValidator.js

@@ -0,0 +1,22 @@
+import { validateObject } from "../commonUtil.js";
+import { isAppStudio } from "@sap-ux/btp-utils";
+import { getLogger } from "@ui5/logger";
+const log = getLogger("@ui5/task-adaptation::AbapConnectionValidator");
+export default class AbapConnectionValidator {
+    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 = 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");
+    }
+}
+//# sourceMappingURL=abapConnectionValidator.js.map

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

@@ -1,8 +1,6 @@
-import { AbapTarget } from "@sap-ux/system-access";
-import { IAbapTargetMeta, IConfiguration, LandscapeType } from "../../model/configuration.js";
+import { 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;
+    validateConfiguration({ destination, target }: IConfiguration): void;
 }

package/dist/util/validator/abapValidator.js

@@ -1,26 +1,14 @@
-import { validateObject } from "../commonUtil.js";
-import { isAppStudio } 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 = isAppStudio() ? ["destination"] : ["url"];
-            validateObject(target, abapTargetProperties, "should be specified in ui5.yaml configuration/target");
-            return target;
+    validateConfiguration({ destination, target }) {
+        if (!destination && !target) {
+            throw new Error("'target' should be specified in ui5.yaml configuration");
         }
-        else if (destination) {
+        else if (destination && !target) {
             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/zipUtil.d.ts

@@ -1 +1 @@
-export declare function unzipZipEntries(zip: Buffer): Promise<Map<string, string>>;
+export declare function unzipZipEntries(zip: Buffer): Promise<Map<string, Buffer>>;

package/dist/util/zipUtil.js

@@ -11,6 +11,6 @@ export async function unzipZipEntries(zip) {
     }
 }
 function mapEntries(entries) {
-    return new Map(entries.filter(entry => !entry.isDirectory).map(entry => [entry.entryName, entry.getData().toString("utf8")]));
+    return new Map(entries.filter(entry => !entry.isDirectory).map(entry => [entry.entryName, entry.getData()]));
 }
 //# sourceMappingURL=zipUtil.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.6.6",
+    "version": "1.6.7",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
     "main": "index.js",
     "scripts": {
@@ -32,15 +32,15 @@
     "author": "SAP SE",
     "license": "Apache-2.0",
     "dependencies": {
-        "@sap-ux/axios-extension": "^2.0.1",
-        "@sap-ux/btp-utils": "^2.0.1",
-        "@sap-ux/store": "^2.0.1",
-        "@sap-ux/system-access": "^1.0.1",
+        "@sap-ux/axios-extension": "^2.0.8",
+        "@sap-ux/btp-utils": "^2.0.6",
+        "@sap-ux/store": "^2.0.6",
+        "@sap-ux/system-access": "^1.0.10",
         "@sap/cf-tools": "^3.2.2",
         "@ui5/fs": "^4.0.1",
         "@ui5/logger": "^4.0.1",
-        "adm-zip": "^0.5.5",
-        "axios": "^1.8.3",
+        "adm-zip": "^0.6.0",
+        "axios": "^1.18.1",
         "crc": "^4.3.2",
         "dotenv": "^16.0.3",
         "filenamify": "^6.0.0",

package/types/ui5.d.ts

@@ -16,6 +16,8 @@ declare class Resource {
     setPath(path: string): void;
     getString(): Promise<string>;
     setString(string: string): void;
+    getBuffer(): Promise<Buffer>;
+    setBuffer(buffer: Buffer): void;
 }
 
 declare interface IWorkspace {

package/dist/util/renamingHandlers/renamingHandler.d.ts

@@ -1,4 +0,0 @@
-export interface IRenamingHandler {
-    before(files: ReadonlyMap<string, string>): void;
-    after(files: Map<string, string>): void;
-}

package/dist/util/renamingHandlers/renamingHandler.js

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