@sap-ux/adp-tooling 0.18.0 → 0.18.1

package/dist/cf/app/discovery.d.ts

@@ -1,19 +1,19 @@
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { CfConfig, CFApp, CfCredentials } from '../../types';
+import type { CfConfig, CFApp, ServiceKeys } from '../../types';
 /**
  * Get the app host ids.
  *
- * @param {CfCredentials[]} credentials - The credentials.
+ * @param {ServiceKeys[]} serviceKeys - The service keys.
  * @returns {string[]} The app host ids.
  */
-export declare function getAppHostIds(credentials: CfCredentials[]): string[];
+export declare function getAppHostIds(serviceKeys: ServiceKeys[]): string[];
 /**
  * Discover apps from FDC API based on credentials.
  *
- * @param {CfCredentials[]} credentials - The credentials containing app host IDs
+ * @param {ServiceKeys[]} serviceKeys - The service keys containing app host IDs
  * @param {CfConfig} cfConfig - The CF configuration
  * @param {ToolsLogger} logger - The logger
  * @returns {Promise<CFApp[]>} The discovered apps
  */
-export declare function getCfApps(credentials: CfCredentials[], cfConfig: CfConfig, logger: ToolsLogger): Promise<CFApp[]>;
+export declare function getCfApps(serviceKeys: ServiceKeys[], cfConfig: CfConfig, logger: ToolsLogger): Promise<CFApp[]>;
 //# sourceMappingURL=discovery.d.ts.map

package/dist/cf/app/discovery.js

@@ -7,13 +7,13 @@ const api_1 = require("../services/api");
 /**
  * Get the app host ids.
  *
- * @param {CfCredentials[]} credentials - The credentials.
+ * @param {ServiceKeys[]} serviceKeys - The service keys.
  * @returns {string[]} The app host ids.
  */
-function getAppHostIds(credentials) {
+function getAppHostIds(serviceKeys) {
     const appHostIds = [];
-    for (const credential of credentials) {
-        const appHostId = credential['html5-apps-repo']?.app_host_id;
+    for (const serviceKey of serviceKeys) {
+        const appHostId = serviceKey.credentials['html5-apps-repo']?.app_host_id;
         if (appHostId) {
             // There might be multiple appHostIds separated by comma
             const ids = appHostId.split(',').map((item) => item.trim());
@@ -25,13 +25,13 @@ function getAppHostIds(credentials) {
 /**
  * Discover apps from FDC API based on credentials.
  *
- * @param {CfCredentials[]} credentials - The credentials containing app host IDs
+ * @param {ServiceKeys[]} serviceKeys - The service keys containing app host IDs
  * @param {CfConfig} cfConfig - The CF configuration
  * @param {ToolsLogger} logger - The logger
  * @returns {Promise<CFApp[]>} The discovered apps
  */
-async function getCfApps(credentials, cfConfig, logger) {
-    const appHostIds = getAppHostIds(credentials);
+async function getCfApps(serviceKeys, cfConfig, logger) {
+    const appHostIds = getAppHostIds(serviceKeys);
     logger?.log(`App Host Ids: ${JSON.stringify(appHostIds)}`);
     // Validate appHostIds array length (max 100 as per API specification)
     if (appHostIds.length > 100) {

package/dist/cf/app/html5-repo.d.ts

@@ -1,5 +1,5 @@
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { HTML5Content, ServiceKeys, Uaa, CfAppParams } from '../../types';
+import type { HTML5Content, ServiceInfo, Uaa, CfAppParams } from '../../types';
 /**
  * Get the OAuth token from HTML5 repository.
  *
@@ -21,9 +21,9 @@ export declare function downloadZip(token: string, appHostId: string, uri: strin
  *
  * @param {string} spaceGuid space guid
  * @param {ToolsLogger} logger logger to log messages
- * @returns {Promise<ServiceKeys>} credentials json object
+ * @returns {Promise<ServiceInfo>} credentials json object
  */
-export declare function getHtml5RepoCredentials(spaceGuid: string, logger: ToolsLogger): Promise<ServiceKeys>;
+export declare function getHtml5RepoCredentials(spaceGuid: string, logger: ToolsLogger): Promise<ServiceInfo>;
 /**
  * Download base app manifest.json and xs-app.json from HTML5 repository.
  *

package/dist/cf/app/html5-repo.js

@@ -64,27 +64,27 @@ async function downloadZip(token, appHostId, uri) {
  *
  * @param {string} spaceGuid space guid
  * @param {ToolsLogger} logger logger to log messages
- * @returns {Promise<ServiceKeys>} credentials json object
+ * @returns {Promise<ServiceInfo>} credentials json object
  */
 async function getHtml5RepoCredentials(spaceGuid, logger) {
     try {
-        let serviceKeys = await (0, api_1.getServiceInstanceKeys)({
+        let serviceInfo = await (0, api_1.getServiceInstanceKeys)({
             spaceGuids: [spaceGuid],
             planNames: ['app-runtime'],
             names: [HTML5_APPS_REPO_RUNTIME]
         }, logger);
-        if (!serviceKeys?.credentials?.length) {
+        if (!serviceInfo?.serviceKeys?.length) {
             const serviceName = await (0, api_1.getServiceNameByTags)(spaceGuid, ['html5-apps-repo-rt']);
             await (0, api_1.createServiceInstance)('app-runtime', HTML5_APPS_REPO_RUNTIME, serviceName, {
                 logger
             });
-            serviceKeys = await (0, api_1.getServiceInstanceKeys)({ names: [HTML5_APPS_REPO_RUNTIME] }, logger);
-            if (!serviceKeys?.credentials?.length) {
+            serviceInfo = await (0, api_1.getServiceInstanceKeys)({ names: [HTML5_APPS_REPO_RUNTIME] }, logger);
+            if (!serviceInfo?.serviceKeys?.length) {
                 logger.debug((0, i18n_1.t)('error.noUaaCredentialsFoundForHtml5Repo'));
                 throw new Error((0, i18n_1.t)('error.cannotFindHtml5RepoRuntime'));
             }
         }
-        return serviceKeys;
+        return serviceInfo;
     }
     catch (e) {
         throw new Error((0, i18n_1.t)('error.failedToGetCredentialsFromHtml5Repo', { error: e.message }));
@@ -102,9 +102,9 @@ async function downloadAppContent(spaceGuid, parameters, logger) {
     const { appHostId, appName, appVersion } = parameters;
     const appNameVersion = `${appName}-${appVersion}`;
     try {
-        const htmlRepoCredentials = await getHtml5RepoCredentials(spaceGuid, logger);
-        const token = await getToken(htmlRepoCredentials?.credentials[0]?.uaa);
-        const uri = `${htmlRepoCredentials?.credentials[0]?.uri}/applications/content/${appNameVersion}?pathSuffixFilter=manifest.json,xs-app.json`;
+        const { serviceKeys, serviceInstance } = await getHtml5RepoCredentials(spaceGuid, logger);
+        const token = await getToken(serviceKeys[0]?.credentials.uaa);
+        const uri = `${serviceKeys[0]?.credentials.uri}/applications/content/${appNameVersion}?pathSuffixFilter=manifest.json,xs-app.json`;
         const zip = await downloadZip(token, appHostId, uri);
         let admZip;
         try {
@@ -124,7 +124,7 @@ async function downloadAppContent(spaceGuid, parameters, logger) {
             const manifest = JSON.parse(zipEntry.getData().toString('utf8'));
             return {
                 entries: admZip.getEntries(),
-                serviceInstanceGuid: htmlRepoCredentials.serviceInstance.guid,
+                serviceInstanceGuid: serviceInstance.guid,
                 manifest: manifest
             };
         }

package/dist/cf/core/auth.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isExternalLoginEnabled = isExternalLoginEnabled;
 exports.isLoggedInCf = isLoggedInCf;
-const CFLocal = require("@sap/cf-tools/out/src/cf-local");
+const cf_tools_1 = require("@sap/cf-tools");
 /**
  * Check if the external login is enabled.
  *
@@ -26,7 +26,7 @@ async function isLoggedInCf(cfConfig, logger) {
         return false;
     }
     try {
-        const orgs = (await CFLocal.cfGetAvailableOrgs());
+        const orgs = await (0, cf_tools_1.cfGetAvailableOrgs)();
         logger?.log(`Available organizations: ${JSON.stringify(orgs)}`);
         return true;
     }

package/dist/cf/services/api.d.ts

@@ -1,19 +1,19 @@
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { CfConfig, CFApp, RequestArguments, ServiceKeys, GetServiceInstanceParams, MtaYaml } from '../../types';
+import type { CfConfig, CFApp, RequestArguments, GetServiceInstanceParams, MtaYaml, ServiceInfo } from '../../types';
 interface CreateServiceOptions {
     xsSecurityProjectName?: string;
     templatePathOverwrite?: string;
     logger?: ToolsLogger;
 }
 /**
- * Get the business service keys.
+ * Get the business service info.
  *
  * @param {string} businessService - The business service.
  * @param {CfConfig} config - The CF config.
  * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<ServiceKeys | null>} The service keys.
+ * @returns {Promise<ServiceInfo | null>} The service info.
  */
-export declare function getBusinessServiceKeys(businessService: string, config: CfConfig, logger: ToolsLogger): Promise<ServiceKeys | null>;
+export declare function getBusinessServiceInfo(businessService: string, config: CfConfig, logger: ToolsLogger): Promise<ServiceInfo | null>;
 /**
  * Get the FDC request arguments.
  *
@@ -64,8 +64,8 @@ export declare function createServices(yamlContent: MtaYaml, initialServices: st
  *
  * @param {GetServiceInstanceParams} serviceInstanceQuery - The service instance query.
  * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<ServiceKeys | null>} The service instance keys.
+ * @returns {Promise<ServiceInfo | null>} The service instance keys.
  */
-export declare function getServiceInstanceKeys(serviceInstanceQuery: GetServiceInstanceParams, logger: ToolsLogger): Promise<ServiceKeys | null>;
+export declare function getServiceInstanceKeys(serviceInstanceQuery: GetServiceInstanceParams, logger: ToolsLogger): Promise<ServiceInfo | null>;
 export {};
 //# sourceMappingURL=api.d.ts.map

package/dist/cf/services/api.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getBusinessServiceKeys = getBusinessServiceKeys;
+exports.getBusinessServiceInfo = getBusinessServiceInfo;
 exports.getFDCRequestArguments = getFDCRequestArguments;
 exports.getFDCApps = getFDCApps;
 exports.createServiceInstance = createServiceInstance;
@@ -46,7 +46,7 @@ exports.getServiceInstanceKeys = getServiceInstanceKeys;
 const fs = __importStar(require("node:fs"));
 const axios_1 = __importDefault(require("axios"));
 const path = __importStar(require("node:path"));
-const CFToolsCli = require("@sap/cf-tools/out/src/cli");
+const cf_tools_1 = require("@sap/cf-tools");
 const btp_utils_1 = require("@sap-ux/btp-utils");
 const i18n_1 = require("../../i18n");
 const project_1 = require("../project");
@@ -57,14 +57,14 @@ const PARAM_MAP = new Map([
     ['names', 'names']
 ]);
 /**
- * Get the business service keys.
+ * Get the business service info.
  *
  * @param {string} businessService - The business service.
  * @param {CfConfig} config - The CF config.
  * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<ServiceKeys | null>} The service keys.
+ * @returns {Promise<ServiceInfo | null>} The service info.
  */
-async function getBusinessServiceKeys(businessService, config, logger) {
+async function getBusinessServiceInfo(businessService, config, logger) {
     const serviceKeys = await getServiceInstanceKeys({
         spaceGuids: [config.space.GUID],
         names: [businessService]
@@ -171,7 +171,7 @@ async function createServiceInstance(plan, serviceInstanceName, serviceName, opt
             }
             commandParameters.push('-c', JSON.stringify(xsSecurity));
         }
-        await CFToolsCli.Cli.execute(commandParameters);
+        await cf_tools_1.Cli.execute(commandParameters);
         logger?.log(`Service instance '${serviceInstanceName}' created successfully`);
     }
     catch (e) {
@@ -227,7 +227,7 @@ async function createServices(yamlContent, initialServices, timestamp, templateP
  *
  * @param {GetServiceInstanceParams} serviceInstanceQuery - The service instance query.
  * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<ServiceKeys | null>} The service instance keys.
+ * @returns {Promise<ServiceInfo | null>} The service instance keys.
  */
 async function getServiceInstanceKeys(serviceInstanceQuery, logger) {
     try {
@@ -236,7 +236,7 @@ async function getServiceInstanceKeys(serviceInstanceQuery, logger) {
             // We can use any instance in the list to connect to HTML5 Repo
             logger?.log(`Use '${serviceInstances[0].name}' HTML5 Repo instance`);
             return {
-                credentials: await getOrCreateServiceKeys(serviceInstances[0], logger),
+                serviceKeys: await getOrCreateServiceKeys(serviceInstances[0], logger),
                 serviceInstance: serviceInstances[0]
             };
         }
@@ -279,7 +279,7 @@ async function getServiceInstance(params) {
  *
  * @param {ServiceInstance} serviceInstance - The service instance.
  * @param {ToolsLogger} logger - The logger.
- * @returns {Promise<ServiceKeys | null>} The service instance keys.
+ * @returns {Promise<ServiceKeys[]>} The service instance keys.
  */
 async function getOrCreateServiceKeys(serviceInstance, logger) {
     const serviceInstanceName = serviceInstance.name;

package/dist/cf/services/cli.d.ts

@@ -1,5 +1,5 @@
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { CfCredentials } from '../../types';
+import type { ServiceKeys } from '../../types';
 /**
  * Checks if Cloud Foundry is installed.
  *
@@ -11,9 +11,9 @@ export declare function isCfInstalled(logger: ToolsLogger): Promise<boolean>;
  * Gets the service instance credentials.
  *
  * @param {string} serviceInstanceGuid - The service instance GUID.
- * @returns {Promise<CfCredentials[]>} The service instance credentials.
+ * @returns {Promise<ServiceKeys[]>} The service instance credentials.
  */
-export declare function getServiceKeys(serviceInstanceGuid: string): Promise<CfCredentials[]>;
+export declare function getServiceKeys(serviceInstanceGuid: string): Promise<ServiceKeys[]>;
 /**
  * Creates a service key.
  *

package/dist/cf/services/cli.js

@@ -4,9 +4,7 @@ exports.isCfInstalled = isCfInstalled;
 exports.getServiceKeys = getServiceKeys;
 exports.createServiceKey = createServiceKey;
 exports.requestCfApi = requestCfApi;
-const CFLocal = require("@sap/cf-tools/out/src/cf-local");
-const CFToolsCli = require("@sap/cf-tools/out/src/cli");
-const types_1 = require("@sap/cf-tools/out/src/types");
+const cf_tools_1 = require("@sap/cf-tools");
 const i18n_1 = require("../../i18n");
 const ENV = { env: { 'CF_COLOR': 'false' } };
 /**
@@ -17,7 +15,7 @@ const ENV = { env: { 'CF_COLOR': 'false' } };
  */
 async function isCfInstalled(logger) {
     try {
-        const response = await CFToolsCli.Cli.execute(['version'], ENV);
+        const response = await cf_tools_1.Cli.execute(['version'], ENV);
         if (response.exitCode !== 0) {
             throw new Error(response.stderr);
         }
@@ -32,16 +30,15 @@ async function isCfInstalled(logger) {
  * Gets the service instance credentials.
  *
  * @param {string} serviceInstanceGuid - The service instance GUID.
- * @returns {Promise<CfCredentials[]>} The service instance credentials.
+ * @returns {Promise<ServiceKeys[]>} The service instance credentials.
  */
 async function getServiceKeys(serviceInstanceGuid) {
     try {
-        return await CFLocal.cfGetInstanceCredentials({
+        return await (0, cf_tools_1.cfGetInstanceCredentials)({
             filters: [
                 {
                     value: serviceInstanceGuid,
-                    // key: eFilters.service_instance_guid
-                    key: types_1.eFilters.service_instance_guid
+                    key: cf_tools_1.eFilters.service_instance_guids
                 }
             ]
         });
@@ -58,7 +55,7 @@ async function getServiceKeys(serviceInstanceGuid) {
  */
 async function createServiceKey(serviceInstanceName, serviceKeyName) {
     try {
-        const cliResult = await CFToolsCli.Cli.execute(['create-service-key', serviceInstanceName, serviceKeyName], ENV);
+        const cliResult = await cf_tools_1.Cli.execute(['create-service-key', serviceInstanceName, serviceKeyName], ENV);
         if (cliResult.exitCode !== 0) {
             throw new Error(cliResult.stderr);
         }
@@ -75,7 +72,7 @@ async function createServiceKey(serviceInstanceName, serviceKeyName) {
  */
 async function requestCfApi(url) {
     try {
-        const response = await CFToolsCli.Cli.execute(['curl', url], ENV);
+        const response = await cf_tools_1.Cli.execute(['curl', url], ENV);
         if (response.exitCode === 0) {
             try {
                 return JSON.parse(response.stdout);

package/dist/cf/utils/validation.d.ts

@@ -1,7 +1,7 @@
 import type AdmZip from 'adm-zip';
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { Manifest } from '@sap-ux/project-access';
-import type { CfCredentials, XsApp } from '../../types';
+import type { ServiceKeys, XsApp } from '../../types';
 /**
  * Validate the smart template application.
  *
@@ -29,9 +29,9 @@ export declare function extractXSApp(zipEntries: AdmZip.IZipEntry[]): XsApp | un
  * Validate the OData endpoints, data sources and routes.
  *
  * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
- * @param {CfCredentials[]} credentials - The credentials.
+ * @param {ServiceKeys[]} serviceKeys - The service keys.
  * @param {ToolsLogger} logger - The logger.
  * @returns {Promise<string[]>} The messages.
  */
-export declare function validateODataEndpoints(zipEntries: AdmZip.IZipEntry[], credentials: CfCredentials[], logger: ToolsLogger): Promise<void>;
+export declare function validateODataEndpoints(zipEntries: AdmZip.IZipEntry[], serviceKeys: ServiceKeys[], logger: ToolsLogger): Promise<void>;
 //# sourceMappingURL=validation.d.ts.map

package/dist/cf/utils/validation.js

@@ -91,11 +91,11 @@ function matchRoutesAndDatasources(dataSources, routes, serviceKeyEndpoints) {
  * Validate the OData endpoints, data sources and routes.
  *
  * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries.
- * @param {CfCredentials[]} credentials - The credentials.
+ * @param {ServiceKeys[]} serviceKeys - The service keys.
  * @param {ToolsLogger} logger - The logger.
  * @returns {Promise<string[]>} The messages.
  */
-async function validateODataEndpoints(zipEntries, credentials, logger) {
+async function validateODataEndpoints(zipEntries, serviceKeys, logger) {
     const messages = [];
     let xsApp;
     try {
@@ -116,7 +116,7 @@ async function validateODataEndpoints(zipEntries, credentials, logger) {
     const dataSources = manifest?.['sap.app']?.dataSources;
     const routes = xsApp?.routes;
     if (dataSources && routes) {
-        const serviceKeyEndpoints = [].concat(...credentials.map((item) => (item.endpoints ? Object.keys(item.endpoints) : [])));
+        const serviceKeyEndpoints = [].concat(...serviceKeys.map(({ credentials }) => (credentials.endpoints ? Object.keys(credentials.endpoints) : [])));
         messages.push(...matchRoutesAndDatasources(dataSources, routes, serviceKeyEndpoints));
     }
     else if (routes && !dataSources) {

package/dist/types.d.ts

@@ -740,14 +740,16 @@ export interface CfAppParams {
 export interface AppParamsExtended extends CfAppParams {
     spaceGuid: string;
 }
-export interface CfCredentials {
-    [key: string]: any;
-    uaa: Uaa;
-    uri: string;
-    endpoints: any;
-}
 export interface ServiceKeys {
-    credentials: CfCredentials[];
+    credentials: {
+        [key: string]: any;
+        uaa: Uaa;
+        uri: string;
+        endpoints: any;
+    };
+}
+export interface ServiceInfo {
+    serviceKeys: ServiceKeys[];
     serviceInstance: ServiceInstance;
 }
 export interface HTML5Content {

package/package.json

@@ -9,7 +9,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aadp-tooling"
   },
-  "version": "0.18.0",
+  "version": "0.18.1",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -24,7 +24,7 @@
   ],
   "dependencies": {
     "@sap-devx/yeoman-ui-types": "1.16.9",
-    "@sap/cf-tools": "0.8.1",
+    "@sap/cf-tools": "3.2.2",
     "adm-zip": "0.5.10",
     "axios": "1.12.2",
     "ejs": "3.1.10",