@ui5/task-adaptation 1.6.7 → 1.6.8

package/CHANGELOG.md

@@ -2,10 +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.6.7...HEAD).
+A list of unreleased changes can be found [here](https://github.com/SAP/ui5-task-adaptation/compare/v1.6.8...HEAD).
+
+<a name="v1.6.8"></a>
+## [v1.6.8] - 2026-08-12
 
 <a name="v1.6.7"></a>
-## [v1.6.7] - 2026-07-28
+## [v1.6.7] - 2026-07-29
 
 <a name="v1.6.6"></a>
 ## [v1.6.6] - 2026-06-30
@@ -164,6 +167,7 @@ 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.6.8]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.7...v1.6.8
 [v1.6.7]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.6...v1.6.7
 [v1.6.6]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.5...v1.6.6
 [v1.6.5]: https://github.com/SAP/ui5-task-adaptation/compare/v1.6.4...v1.6.5

package/dist/appVariant.d.ts

@@ -10,7 +10,6 @@ export default class AppVariant {
     movedFiles: Map<string, string>;
     private renaming;
     static fromWorkspace(workspace: IWorkspace, projectNamespace: string): Promise<AppVariant>;
-    static fromProject(): Promise<AppVariant>;
     static fromFiles(files: ReadonlyMap<string, Buffer>): AppVariant;
     private constructor();
     getProcessedFiles(): ReadonlyMap<string, Buffer>;

package/dist/appVariant.js

@@ -21,13 +21,6 @@ export default class AppVariant {
         const files = await ResourceUtil.toFileMap(resources, projectNamespace);
         return new AppVariant(files, resources);
     }
-    static async fromProject() {
-        // previewManifest only merges manifest changes, that is why we
-        // just need the app variant descriptor and *.change files from the workspace.
-        const EXTENSIONS_TO_PROCESS = "change,appdescr_variant";
-        const files = await ResourceUtil.byGlobInProject(`/**/*.{${EXTENSIONS_TO_PROCESS}}`);
-        return new AppVariant(files);
-    }
     static fromFiles(files) {
         return new AppVariant(files);
     }

package/dist/bundle.js

@@ -2183,34 +2183,52 @@ function processTerminologies(oChangeContent, sAppId) {
     });
   }
 }
+function getEnhancementSettings(oChange, oChangeContent, sAppId) {
+  const sI18n = oChange.getTexts()?.i18n;
+  if (sI18n) {
+    return {
+      bundleName: ApplyUtil.formatBundleName(sAppId, sI18n)
+    };
+  }
+  const oEnhancementSettings = Object.assign({}, oChangeContent);
+  oEnhancementSettings.terminologies &&= Object.keys(oEnhancementSettings.terminologies).reduce((oResult, sTerminology) => {
+    oResult[sTerminology] = Object.assign({}, oEnhancementSettings.terminologies[sTerminology]);
+    return oResult;
+  }, {});
+  if (hasBundleUrlAndNotBundleName(oEnhancementSettings)) {
+    oEnhancementSettings.bundleName = ApplyUtil.formatBundleName(sAppId, oEnhancementSettings.bundleUrl);
+    delete oEnhancementSettings.bundleUrl;
+  }
+  processTerminologies(oEnhancementSettings, sAppId);
+  delete oEnhancementSettings.modelId;
+  delete oEnhancementSettings.createIfMissing;
+  return oEnhancementSettings;
+}
 const AddNewModelEnhanceWith = {
   applyChange(oManifest, oChange) {
     const oChangeContent = oChange.getContent();
     const sModelId = oChangeContent.modelId;
-    const oModel = oManifest["sap.ui5"].models[sModelId];
-    if (oModel) {
-      if (oModel.type && oModel.type === "sap.ui.model.resource.ResourceModel") {
-        if (!(oModel.settings && oModel.settings.enhanceWith)) {
-          ObjectPath.set("settings.enhanceWith", [], oModel);
-        }
-        const sAppId = oManifest["sap.app"].id;
-        const sI18n = oChange.getTexts()?.i18n;
-        const oEnhanceWith = oModel.settings.enhanceWith;
-        if (sI18n) {
-          oEnhanceWith.push({
-            bundleName: ApplyUtil.formatBundleName(sAppId, sI18n)
-          });
-          return oManifest;
-        }
-        if (hasBundleUrlAndNotBundleName(oChangeContent)) {
-          oChangeContent.bundleName = ApplyUtil.formatBundleName(sAppId, oChangeContent.bundleUrl);
-          delete oChangeContent.bundleUrl;
-        }
-        processTerminologies(oChangeContent, sAppId);
-        delete oChangeContent.modelId;
-        if (Object.keys(oChangeContent).length > 0) {
-          oEnhanceWith.push(oChangeContent);
-        }
+    const oModels = oManifest["sap.ui5"].models;
+    const sAppId = oManifest["sap.app"].id;
+    const oEnhancementSettings = getEnhancementSettings(oChange, oChangeContent, sAppId);
+    const oModel = oModels[sModelId];
+    if (!oModel) {
+      if (!oChangeContent.createIfMissing) {
+        throw Error(`Model with ID '${sModelId}' does not exist. Set createIfMissing to true to create it.`);
+      }
+      oModels[sModelId] = {
+        type: "sap.ui.model.resource.ResourceModel",
+        settings: oEnhancementSettings
+      };
+      return oManifest;
+    }
+    if (oModel.type && oModel.type === "sap.ui.model.resource.ResourceModel") {
+      if (!(oModel.settings && oModel.settings.enhanceWith)) {
+        ObjectPath.set("settings.enhanceWith", [], oModel);
+      }
+      const oEnhanceWith = oModel.settings.enhanceWith;
+      if (!fnIsEmptyObject(oEnhancementSettings)) {
+        oEnhanceWith.push(oEnhancementSettings);
       }
     }
     return oManifest;
@@ -2303,7 +2321,7 @@ function Version(vMajor, iMinor, iPatch, sSuffix) {
     return sSuffix;
   };
   this.compareTo = function (vOtherMajor, iOtherMinor, iOtherPatch, sOtherSuffix) {
-    var vOther = Version.apply(window, arguments);
+    var vOther = Version.apply(null, arguments);
     return vMajor - vOther.getMajor() || iMinor - vOther.getMinor() || iPatch - vOther.getPatch() || (sSuffix < vOther.getSuffix() ? -1 : sSuffix === vOther.getSuffix() ? 0 : 1);
   };
 }
@@ -4598,7 +4616,7 @@ var fnEqual = function (a, b, maxDepth, contains, depth) {
     if (!contains && Object.keys(a).length !== Object.keys(b).length) {
       return false;
     }
-    if (a instanceof Node) {
+    if (typeof Node !== "undefined" && a instanceof Node) {
       return a.isEqualNode(b);
     }
     if (a instanceof Date) {
@@ -6713,6 +6731,9 @@ _Helper = {
       return oCurrent && (sSegment in oCurrent) ? oCurrent[sSegment] : undefined;
     }, oObject);
   },
+  dropQuery: function (sResourcePathWithQuery) {
+    return sResourcePathWithQuery.split("?")[0];
+  },
   encode: function (sPart, bEncodeEquals) {
     var sEncoded = encodeURI(sPart).replace(rAmpersand, "%26").replace(rHash, "%23").replace(rPlus, "%2B");
     if (bEncodeEquals) {

package/dist/index.d.ts

@@ -12,4 +12,4 @@ export default _default;
  * the cache is empty, this throws with a message directing the user to run
  * a full build first.
  */
-export declare function previewManifest({ options }: ITaskParameters): Promise<any>;
+export declare function previewManifest({ workspace, options }: ITaskParameters): Promise<any>;

package/dist/index.js

@@ -50,9 +50,9 @@ export default async ({ workspace, options, taskUtil }) => {
  * the cache is empty, this throws with a message directing the user to run
  * a full build first.
  */
-export async function previewManifest({ options }) {
+export async function previewManifest({ workspace, options }) {
     const { repository, adapter } = await initialize(options.configuration, { useCacheRepository: true });
-    const adaptationProject = await AppVariant.fromProject();
+    const adaptationProject = await AppVariant.fromWorkspace(workspace, options.projectNamespace);
     const [baseAppResource] = await repository.getAppVariantIdHierarchy(adaptationProject.reference);
     const cachedBaseAppFiles = await repository.fetch(baseAppResource);
     const baseApp = BaseApp.fromFiles(cachedBaseAppFiles);

package/dist/model/types.d.ts

@@ -22,6 +22,7 @@ export interface IGetServiceInstanceParams {
 export interface IServiceInstance {
     name: string;
     guid: string;
+    type?: string;
 }
 export interface IResource {
     name: string;

package/dist/util/cfUtil.d.ts

@@ -10,10 +10,9 @@ export default class CFUtil {
      */
     static getServiceInstanceKeys(getServiceInstanceParams: IGetServiceInstanceParams, createServiceInstanceParams?: ICreateServiceInstanceParams): Promise<IServiceKeys>;
     static createService(params: ICreateServiceInstanceParams): Promise<void>;
-    private static getOrCreateServiceKeys;
-    private static getServiceKeys;
+    private static getOrCreateCredentials;
+    private static fetchCredentials;
     private static createServiceKey;
-    private static deleteServiceKeyUnsafe;
     private static getServiceInstance;
     static processCfErrors(errors?: ICfError[]): void;
     static requestCfApi(url: string): Promise<IResource[]>;
@@ -22,14 +21,15 @@ export default class CFUtil {
     private static errorsToString;
     private static parseJson;
     /**
-     * Get service keys and return the first one with valid endpoints
+     * Return the most recently created service credential binding (key) for the given service instance,
+     * or undefined if no keys exist.
      * @private
      * @static
      * @param {string} serviceInstanceGuid the service instance guid
-     * @return {Promise<ServiceCredentials | null>} the first service key with valid endpoints, or null if none found
+     * @return {Promise<any | undefined>} the newest binding object ({ name, guid, created_at, … }) or undefined
      * @memberof CFUtil
      */
-    private static getServiceKeyWithValidEndpoints;
+    private static getNewestServiceKey;
     /**
      * Get service keys for a service instance by name. If the existing service key
      * has endpoints as strings instead of objects, a new service key will be created.
@@ -49,24 +49,6 @@ export default class CFUtil {
      * @memberof CFUtil
      */
     private static hasValidEndpoints;
-    /**
-     * Get all service key names for a service instance
-     * @private
-     * @static
-     * @param {string} serviceInstanceGuid the service instance guid
-     * @return {Promise<string[]>} promise with array of service key names
-     * @memberof CFUtil
-     */
-    private static getAllServiceKeyNames;
-    /**
-     * Generate a unique service key name in format serviceInstanceName-key-N
-     * @static
-     * @param {string} serviceInstanceName the service instance name
-     * @param {string} serviceInstanceGuid the service instance guid
-     * @return {Promise<string>} promise with unique service key name
-     * @memberof CFUtil
-     */
-    static generateUniqueServiceKeyName(serviceInstanceName: string, serviceInstanceGuid: string): Promise<string>;
     /**
      * Get space guid from configuration or local CF fodler
      * @static

package/dist/util/cfUtil.js

@@ -1,7 +1,6 @@
-import { cfCreateService, cfGetInstanceCredentials } from "@sap/cf-tools/out/src/cf-local.js";
+import { cfCreateService } from "@sap/cf-tools/out/src/cf-local.js";
 import { getSpaceGuidThrowIfUndefined } from "@sap/cf-tools/out/src/utils.js";
 import { Cli } from "@sap/cf-tools/out/src/cli.js";
-import { eFilters } from "@sap/cf-tools/out/src/types.js";
 import { getLogger } from "@ui5/logger";
 import AuthenticationError from "../model/authenticationError.js";
 const log = getLogger("@ui5/task-adaptation::CFUtil");
@@ -25,12 +24,12 @@ export default class CFUtil {
         }
         // we can use any instance in the list to connect to HTML5 Repo
         log.verbose(`Use '${serviceInstances[0].name}' HTML5 Repo Runtime service instance`);
-        const serviceKeys = await this.getOrCreateServiceKeys(serviceInstances[0]);
-        if (!(serviceKeys?.length > 0)) {
+        const credentials = await this.getOrCreateCredentials(serviceInstances[0]);
+        if (!credentials) {
             throw new Error(`Cannot get service keys for '${getServiceInstanceParams.names?.join(", ")}' service in current space: ${getServiceInstanceParams.spaceGuids?.join(", ")}`);
         }
         return {
-            credentials: serviceKeys[0].credentials,
+            credentials,
             serviceInstance: serviceInstances[0]
         };
     }
@@ -52,27 +51,28 @@ export default class CFUtil {
             throw new Error(`Cannot create a service instance '${params.serviceInstanceName}' in space '${params.spaceGuid}': ${error.message}`);
         }
     }
-    static async getOrCreateServiceKeys(serviceInstance) {
-        const credentials = await this.getServiceKeys(serviceInstance.guid);
-        if (credentials.length === 0) {
+    static async getOrCreateCredentials(serviceInstance) {
+        if (serviceInstance.type === "user-provided") {
+            log.verbose(`Service instance '${serviceInstance.name}' is user-provided, fetching credentials directly`);
+            return this.fetchCredentials(`/v3/service_instances/${serviceInstance.guid}/credentials`);
+        }
+        let key = await this.getNewestServiceKey(serviceInstance.guid);
+        if (key == null) {
             const serviceKeyName = serviceInstance.name + "_key";
             log.info(`Creating service key '${serviceKeyName}' for service instance '${serviceInstance.name}'`);
             await this.createServiceKey(serviceInstance.name, serviceKeyName);
+            key = await this.getNewestServiceKey(serviceInstance.guid);
+            if (key == null) {
+                throw new Error(`Service key was created for '${serviceInstance.name}' but could not be retrieved`);
+            }
         }
-        else {
-            return credentials;
-        }
-        return this.getServiceKeys(serviceInstance.guid);
+        log.verbose(`Using service key '${key.name}' for service instance '${serviceInstance.name}'`);
+        return this.fetchCredentials(`/v3/service_credential_bindings/${key.guid}/details`);
     }
-    static getServiceKeys(serviceInstanceGuid) {
-        return cfGetInstanceCredentials({
-            filters: [{
-                    value: serviceInstanceGuid,
-                    key: eFilters.service_instance_guids
-                }]
-        }).catch((error) => {
-            throw new Error("Failed to get service credentials: " + error.message);
-        });
+    static async fetchCredentials(url) {
+        const parsed = this.parseJson(await this.cfExecute(["curl", url]));
+        this.processCfErrors(parsed?.errors);
+        return parsed.credentials;
     }
     static async createServiceKey(serviceInstanceName, serviceKeyName) {
         try {
@@ -82,12 +82,6 @@ export default class CFUtil {
             throw new Error(`Couldn't create a service key for instance: ${serviceInstanceName}: ${error}`);
         }
     }
-    static deleteServiceKeyUnsafe(serviceInstanceName, serviceKeyName) {
-        // Fire and forget - async delete without waiting for result or handling errors
-        this.cfExecute(["delete-service-key", serviceInstanceName, serviceKeyName, "-f"]).catch(() => {
-            // Ignore any errors - this is intentionally unsafe
-        });
-    }
     static async getServiceInstance(params) {
         const PARAM_MAP = {
             spaceGuids: "space_guids",
@@ -101,7 +95,8 @@ export default class CFUtil {
         const resources = await this.requestCfApi(uri);
         return resources.map((service) => ({
             name: service.name,
-            guid: service.guid
+            guid: service.guid,
+            type: service.type
         }));
     }
     static processCfErrors(errors) {
@@ -174,18 +169,21 @@ export default class CFUtil {
         }
     }
     /**
-     * Get service keys and return the first one with valid endpoints
+     * Return the most recently created service credential binding (key) for the given service instance,
+     * or undefined if no keys exist.
      * @private
      * @static
      * @param {string} serviceInstanceGuid the service instance guid
-     * @return {Promise<ServiceCredentials | null>} the first service key with valid endpoints, or null if none found
+     * @return {Promise<any | undefined>} the newest binding object ({ name, guid, created_at, … }) or undefined
      * @memberof CFUtil
      */
-    static async getServiceKeyWithValidEndpoints(serviceInstanceGuid) {
+    static async getNewestServiceKey(serviceInstanceGuid) {
         try {
-            const serviceKeys = await this.getServiceKeys(serviceInstanceGuid);
-            // Find and return the first key with valid endpoints
-            return serviceKeys.find((key) => key.credentials?.endpoints && this.hasValidEndpoints(key.credentials.endpoints));
+            const keyList = await this.requestCfApi(`/v3/service_credential_bindings?type=key&service_instance_guids=${serviceInstanceGuid}`);
+            if (!keyList?.length) {
+                return undefined;
+            }
+            return keyList.toSorted((a, b) => new Date(b.created_at).getTime() - new Date(a.created_at).getTime())[0];
         }
         catch (error) {
             throw new Error("Failed to get service credentials: " + error.message);
@@ -212,30 +210,11 @@ export default class CFUtil {
         }
         const serviceInstance = serviceInstances[0];
         log.verbose(`Found service instance '${serviceInstance.name}' with guid: ${serviceInstance.guid}`);
-        // If no valid service key found, create a new one with unique name
-        const uniqueServiceKeyNamePromise = this.generateUniqueServiceKeyName(serviceInstance.name, serviceInstance.guid);
-        // Get service keys with credentials to find any with valid endpoints:
-        // object with url and destination instead of a single url string
-        const validKey = await this.getServiceKeyWithValidEndpoints(serviceInstance.guid);
-        if (validKey) {
-            log.verbose(`Using existing service key with valid endpoints structure`);
-            return validKey.credentials;
-        }
-        const uniqueServiceKeyName = await uniqueServiceKeyNamePromise;
-        log.verbose(`No valid service key found with proper endpoints structure. Creating new service key '${uniqueServiceKeyName}' for '${serviceInstance.name}'`);
-        await this.createServiceKey(serviceInstance.name, uniqueServiceKeyName);
-        // Get the newly created service key and validate its endpoints
-        const newValidKey = await this.getServiceKeyWithValidEndpoints(serviceInstance.guid);
-        if (newValidKey) {
-            log.verbose(`Using newly created service key with valid endpoints structure`);
-            return newValidKey.credentials;
+        const credentials = await this.getOrCreateCredentials(serviceInstance);
+        if (!credentials?.endpoints || !this.hasValidEndpoints(credentials.endpoints)) {
+            log.info(`Service key for '${serviceInstance.name}' does not have endpoints with service urls for xs-app.json update`);
         }
-        // Clean up the created service key since it doesn't have valid
-        // endpoints. We don't throw an error here even if no valid endpoints
-        // found. We assume that there might be no coincidence between
-        // credential endpoints and xs-app.json destinations.
-        this.deleteServiceKeyUnsafe(serviceInstance.name, uniqueServiceKeyName);
-        log.verbose(`Created service key '${uniqueServiceKeyName}' does not have valid endpoints structure. Triggered deletion of invalid service key '${uniqueServiceKeyName}'`);
+        return credentials;
     }
     /**
      * Check if endpoints object has at least one property that is an object
@@ -252,42 +231,6 @@ export default class CFUtil {
         // Check if at least one property of endpoints is an object
         return Object.values(endpoints).some(value => value && typeof value === 'object' && !Array.isArray(value));
     }
-    /**
-     * Get all service key names for a service instance
-     * @private
-     * @static
-     * @param {string} serviceInstanceGuid the service instance guid
-     * @return {Promise<string[]>} promise with array of service key names
-     * @memberof CFUtil
-     */
-    static async getAllServiceKeyNames(serviceInstanceGuid) {
-        try {
-            const serviceKeys = await this.requestCfApi(`/v3/service_credential_bindings?type=key&service_instance_guids=${serviceInstanceGuid}`);
-            return serviceKeys.map((key) => key.name);
-        }
-        catch (error) {
-            throw new Error(`Failed to get service key names: ${error.message}`);
-        }
-    }
-    /**
-     * Generate a unique service key name in format serviceInstanceName-key-N
-     * @static
-     * @param {string} serviceInstanceName the service instance name
-     * @param {string} serviceInstanceGuid the service instance guid
-     * @return {Promise<string>} promise with unique service key name
-     * @memberof CFUtil
-     */
-    static async generateUniqueServiceKeyName(serviceInstanceName, serviceInstanceGuid) {
-        const existingKeyNames = await this.getAllServiceKeyNames(serviceInstanceGuid);
-        let counter = 0;
-        let keyName;
-        do {
-            keyName = `${serviceInstanceName}-key-${counter}`;
-            counter++;
-        } while (existingKeyNames.includes(keyName));
-        log.verbose(`Generated unique service key name: ${keyName}`);
-        return keyName;
-    }
     /**
      * Get space guid from configuration or local CF fodler
      * @static

package/dist/util/resourceUtil.js

@@ -126,9 +126,13 @@ export default class ResourceUtil {
     }
     static async toFileMap(resources, projectNamespace) {
         const files = new Map();
-        const rootFolderLength = projectNamespace ? ResourceUtil.getRootFolder(projectNamespace).length : 0;
+        const rootFolder = projectNamespace ? ResourceUtil.getRootFolder(projectNamespace) : undefined;
         for (const resource of resources) {
-            files.set(resource.getPath().substring(rootFolderLength + 1), await resource.getBuffer());
+            const resourcePath = resource.getPath();
+            const filename = rootFolder && resourcePath.startsWith(rootFolder)
+                ? resourcePath.substring(rootFolder.length + 1)
+                : resourcePath.substring(1);
+            files.set(filename, await resource.getBuffer());
         }
         return files;
     }

package/package.json

@@ -1,8 +1,14 @@
 {
     "name": "@ui5/task-adaptation",
-    "version": "1.6.7",
+    "version": "1.6.8",
     "description": "Custom task for ui5-builder which allows building UI5 Flexibility Adaptation Projects for SAP BTP, Cloud Foundry environment",
-    "main": "index.js",
+    "main": "dist/index.js",
+    "exports": {
+        ".": {
+            "import": "./dist/index.js",
+            "types": "./dist/index.d.ts"
+        }
+    },
     "scripts": {
         "test": "npm run lint && npm run build && npm run coverage",
         "lint": "eslint ./src ./test/lib",