@sap-ux/adp-tooling 0.18.112 → 0.18.113

package/dist/btp/api.d.ts

@@ -0,0 +1,22 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { Uaa, BtpDestinationConfig } from '../types';
+/**
+ * Obtain an OAuth2 access token using the client credentials grant.
+ *
+ * @param uaa - UAA service credentials (clientid, clientsecret, url).
+ * @param logger - Optional logger.
+ * @returns OAuth2 access token.
+ */
+export declare function getToken(uaa: Uaa, logger?: ToolsLogger): Promise<string>;
+/**
+ * Get a single destination's configuration from the BTP Destination Configuration API.
+ * Note: This calls the BTP Destination Configuration API, not the BAS listDestinations API.
+ *
+ * @param uri - Destination Configuration API base URI (e.g. https://destination-configuration.cfapps.us20.hana.ondemand.com).
+ * @param token - OAuth2 bearer token obtained via {@link getToken}.
+ * @param destinationName - Name of the destination to look up.
+ * @param logger - Optional logger.
+ * @returns The destinationConfiguration object (e.g. Name, ProxyType, URL, Authentication) or undefined on failure.
+ */
+export declare function getBtpDestinationConfig(uri: string, token: string, destinationName: string, logger?: ToolsLogger): Promise<BtpDestinationConfig | undefined>;
+//# sourceMappingURL=api.d.ts.map

package/dist/btp/api.js

@@ -0,0 +1,63 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getToken = getToken;
+exports.getBtpDestinationConfig = getBtpDestinationConfig;
+const axios_1 = __importDefault(require("axios"));
+const i18n_1 = require("../i18n");
+/**
+ * Obtain an OAuth2 access token using the client credentials grant.
+ *
+ * @param uaa - UAA service credentials (clientid, clientsecret, url).
+ * @param logger - Optional logger.
+ * @returns OAuth2 access token.
+ */
+async function getToken(uaa, logger) {
+    const auth = Buffer.from(`${uaa.clientid}:${uaa.clientsecret}`);
+    const options = {
+        headers: {
+            'Content-Type': 'application/x-www-form-urlencoded',
+            'Authorization': 'Basic ' + auth.toString('base64')
+        }
+    };
+    const uri = `${uaa.url}/oauth/token`;
+    logger?.debug(`Requesting OAuth token from ${uri}`);
+    try {
+        const response = await axios_1.default.post(uri, 'grant_type=client_credentials', options);
+        logger?.debug('OAuth token obtained successfully');
+        return response.data['access_token'];
+    }
+    catch (e) {
+        logger?.error(`Failed to obtain OAuth token from ${uri}: ${e.message}`);
+        throw new Error((0, i18n_1.t)('error.failedToGetAuthKey', { error: e.message }));
+    }
+}
+/**
+ * Get a single destination's configuration from the BTP Destination Configuration API.
+ * Note: This calls the BTP Destination Configuration API, not the BAS listDestinations API.
+ *
+ * @param uri - Destination Configuration API base URI (e.g. https://destination-configuration.cfapps.us20.hana.ondemand.com).
+ * @param token - OAuth2 bearer token obtained via {@link getToken}.
+ * @param destinationName - Name of the destination to look up.
+ * @param logger - Optional logger.
+ * @returns The destinationConfiguration object (e.g. Name, ProxyType, URL, Authentication) or undefined on failure.
+ */
+async function getBtpDestinationConfig(uri, token, destinationName, logger) {
+    const url = `${uri}/destination-configuration/v1/destinations/${encodeURIComponent(destinationName)}`;
+    logger?.debug(`Fetching BTP destination config for "${destinationName}" from ${url}`);
+    try {
+        const response = await axios_1.default.get(url, {
+            headers: { 'Authorization': `Bearer ${token}` }
+        });
+        const config = response.data?.destinationConfiguration;
+        logger?.debug(`Destination "${destinationName}" config: ProxyType=${config?.ProxyType}`);
+        return config;
+    }
+    catch (e) {
+        logger?.error(`Failed to fetch destination config for "${destinationName}": ${e.message}`);
+        return undefined;
+    }
+}
+//# sourceMappingURL=api.js.map

package/dist/btp/index.d.ts

@@ -0,0 +1,2 @@
+export * from './api';
+//# sourceMappingURL=index.d.ts.map

package/dist/btp/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -1,12 +1,5 @@
 import type { ToolsLogger } from '@sap-ux/logger';
-import type { HTML5Content, ServiceInfo, Uaa, CfAppParams } from '../../types';
-/**
- * Get the OAuth token from HTML5 repository.
- *
- * @param {Uaa} uaa UAA credentials
- * @returns {Promise<string>} OAuth token
- */
-export declare function getToken(uaa: Uaa): Promise<string>;
+import type { HTML5Content, ServiceInfo, CfAppParams } from '../../types';
 /**
  * Download zip from HTML5 repository.
  *

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

@@ -3,38 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getToken = getToken;
 exports.downloadZip = downloadZip;
 exports.getHtml5RepoCredentials = getHtml5RepoCredentials;
 exports.downloadAppContent = downloadAppContent;
 const axios_1 = __importDefault(require("axios"));
 const adm_zip_1 = __importDefault(require("adm-zip"));
 const i18n_1 = require("../../i18n");
-const api_1 = require("../services/api");
+const api_1 = require("../../btp/api");
+const api_2 = require("../services/api");
 const HTML5_APPS_REPO_RUNTIME = 'html5-apps-repo-runtime';
-/**
- * Get the OAuth token from HTML5 repository.
- *
- * @param {Uaa} uaa UAA credentials
- * @returns {Promise<string>} OAuth token
- */
-async function getToken(uaa) {
-    const auth = Buffer.from(`${uaa.clientid}:${uaa.clientsecret}`);
-    const options = {
-        headers: {
-            'Content-Type': 'application/json',
-            'Authorization': 'Basic ' + auth.toString('base64')
-        }
-    };
-    const uri = `${uaa.url}/oauth/token?grant_type=client_credentials`;
-    try {
-        const response = await axios_1.default.get(uri, options);
-        return response.data['access_token'];
-    }
-    catch (e) {
-        throw new Error((0, i18n_1.t)('error.failedToGetAuthKey', { error: e.message }));
-    }
-}
 /**
  * Download zip from HTML5 repository.
  *
@@ -68,17 +45,17 @@ async function downloadZip(token, appHostId, uri) {
  */
 async function getHtml5RepoCredentials(spaceGuid, logger) {
     try {
-        let serviceInfo = await (0, api_1.getOrCreateServiceInstanceKeys)({
+        let serviceInfo = await (0, api_2.getOrCreateServiceInstanceKeys)({
             spaceGuids: [spaceGuid],
             planNames: ['app-runtime'],
             names: [HTML5_APPS_REPO_RUNTIME]
         }, logger);
         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, {
+            const serviceName = await (0, api_2.getServiceNameByTags)(spaceGuid, ['html5-apps-repo-rt']);
+            await (0, api_2.createServiceInstance)('app-runtime', HTML5_APPS_REPO_RUNTIME, serviceName, {
                 logger
             });
-            serviceInfo = await (0, api_1.getOrCreateServiceInstanceKeys)({ names: [HTML5_APPS_REPO_RUNTIME] }, logger);
+            serviceInfo = await (0, api_2.getOrCreateServiceInstanceKeys)({ 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'));
@@ -103,7 +80,7 @@ async function downloadAppContent(spaceGuid, parameters, logger) {
     const appNameVersion = `${appName}-${appVersion}`;
     try {
         const { serviceKeys, serviceInstance } = await getHtml5RepoCredentials(spaceGuid, logger);
-        const token = await getToken(serviceKeys[0]?.credentials.uaa);
+        const token = await (0, api_1.getToken)(serviceKeys[0]?.credentials.uaa, logger);
         const uri = `${serviceKeys[0]?.credentials.uri}/applications/content/${appNameVersion}?pathSuffixFilter=manifest.json,xs-app.json`;
         const zip = await downloadZip(token, appHostId, uri);
         let admZip;

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

@@ -37,4 +37,31 @@ export declare function updateServiceInstance(serviceInstanceName: string, param
  * @returns {Promise<T>} The response.
  */
 export declare function requestCfApi<T = unknown>(url: string): Promise<T>;
+/**
+ * Check whether a CF app exists.
+ *
+ * @param appName - CF app name.
+ * @returns True if the app exists.
+ */
+export declare function checkAppExists(appName: string): Promise<boolean>;
+/**
+ * Push a minimal no-route CF app from a given directory.
+ *
+ * @param appName - CF app name.
+ * @param appPath - Local path to push.
+ * @param args - Additional cf push arguments.
+ */
+export declare function pushApp(appName: string, appPath: string, args?: string[]): Promise<void>;
+/**
+ * Enable SSH access on a CF app.
+ *
+ * @param appName - CF app name.
+ */
+export declare function enableSsh(appName: string): Promise<void>;
+/**
+ * Restart a CF app using rolling strategy.
+ *
+ * @param appName - CF app name.
+ */
+export declare function restartApp(appName: string): Promise<void>;
 //# sourceMappingURL=cli.d.ts.map

package/dist/cf/services/cli.js

@@ -5,6 +5,10 @@ exports.getServiceKeys = getServiceKeys;
 exports.createServiceKey = createServiceKey;
 exports.updateServiceInstance = updateServiceInstance;
 exports.requestCfApi = requestCfApi;
+exports.checkAppExists = checkAppExists;
+exports.pushApp = pushApp;
+exports.enableSsh = enableSsh;
+exports.restartApp = restartApp;
 const cf_tools_1 = require("@sap/cf-tools");
 const i18n_1 = require("../../i18n");
 const ENV = { env: { 'CF_COLOR': 'false' } };
@@ -141,4 +145,49 @@ async function requestCfApi(url) {
         throw new Error((0, i18n_1.t)('error.failedToRequestCFAPI', { error: e.message }));
     }
 }
+/**
+ * Check whether a CF app exists.
+ *
+ * @param appName - CF app name.
+ * @returns True if the app exists.
+ */
+async function checkAppExists(appName) {
+    const result = await cf_tools_1.Cli.execute(['app', appName], ENV);
+    return result.exitCode === 0;
+}
+/**
+ * Push a minimal no-route CF app from a given directory.
+ *
+ * @param appName - CF app name.
+ * @param appPath - Local path to push.
+ * @param args - Additional cf push arguments.
+ */
+async function pushApp(appName, appPath, args = []) {
+    const result = await cf_tools_1.Cli.execute(['push', appName, '-p', appPath, ...args], ENV);
+    if (result.exitCode !== 0) {
+        throw new Error((0, i18n_1.t)('error.cfPushFailed', { appName, error: result.stderr }));
+    }
+}
+/**
+ * Enable SSH access on a CF app.
+ *
+ * @param appName - CF app name.
+ */
+async function enableSsh(appName) {
+    const result = await cf_tools_1.Cli.execute(['enable-ssh', appName], ENV);
+    if (result.exitCode !== 0) {
+        throw new Error((0, i18n_1.t)('error.cfEnableSshFailed', { appName, error: result.stderr }));
+    }
+}
+/**
+ * Restart a CF app using rolling strategy.
+ *
+ * @param appName - CF app name.
+ */
+async function restartApp(appName) {
+    const result = await cf_tools_1.Cli.execute(['restart', appName, '--strategy', 'rolling', '--no-wait'], ENV);
+    if (result.exitCode !== 0) {
+        throw new Error((0, i18n_1.t)('error.cfRestartFailed', { appName, error: result.stderr }));
+    }
+}
 //# sourceMappingURL=cli.js.map

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

@@ -1,4 +1,5 @@
 export * from './api';
+export * from './ssh';
 export * from './cli';
 export * from './manifest';
 //# sourceMappingURL=index.d.ts.map

package/dist/cf/services/index.js

@@ -15,6 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./api"), exports);
+__exportStar(require("./ssh"), exports);
 __exportStar(require("./cli"), exports);
 __exportStar(require("./manifest"), exports);
 //# sourceMappingURL=index.js.map

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

@@ -0,0 +1,21 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+/**
+ * Default CF app name used for SSH tunneling to the connectivity proxy.
+ */
+export declare const DEFAULT_TUNNEL_APP_NAME = "adp-ssh-tunnel-app";
+/**
+ * Ensure a tunnel app exists in CF. If not found, deploy a minimal no-route app
+ * using the binary_buildpack with minimum memory so it can serve as an SSH target.
+ *
+ * @param appName - CF app name.
+ * @param logger - Logger instance.
+ */
+export declare function ensureTunnelAppExists(appName: string, logger: ToolsLogger): Promise<void>;
+/**
+ * Enable SSH on a CF app and restart it.
+ *
+ * @param appName - CF app name.
+ * @param logger - Logger instance.
+ */
+export declare function enableSshAndRestart(appName: string, logger: ToolsLogger): Promise<void>;
+//# sourceMappingURL=ssh.d.ts.map

package/dist/cf/services/ssh.js

@@ -0,0 +1,64 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_TUNNEL_APP_NAME = void 0;
+exports.ensureTunnelAppExists = ensureTunnelAppExists;
+exports.enableSshAndRestart = enableSshAndRestart;
+const node_fs_1 = __importDefault(require("node:fs"));
+const node_os_1 = __importDefault(require("node:os"));
+const node_path_1 = __importDefault(require("node:path"));
+const cli_1 = require("./cli");
+/**
+ * Default CF app name used for SSH tunneling to the connectivity proxy.
+ */
+exports.DEFAULT_TUNNEL_APP_NAME = 'adp-ssh-tunnel-app';
+/**
+ * Ensure a tunnel app exists in CF. If not found, deploy a minimal no-route app
+ * using the binary_buildpack with minimum memory so it can serve as an SSH target.
+ *
+ * @param appName - CF app name.
+ * @param logger - Logger instance.
+ */
+async function ensureTunnelAppExists(appName, logger) {
+    if (await (0, cli_1.checkAppExists)(appName)) {
+        logger.info(`Tunnel app "${appName}" already exists.`);
+        return;
+    }
+    logger.debug(`Tunnel app "${appName}" not found. Deploying minimal app...`);
+    const tmpDir = node_fs_1.default.mkdtempSync(node_path_1.default.join(node_os_1.default.tmpdir(), 'adp-tunnel-'));
+    node_fs_1.default.writeFileSync(node_path_1.default.join(tmpDir, '.keep'), '');
+    try {
+        await (0, cli_1.pushApp)(appName, tmpDir, [
+            '--no-route',
+            '-m',
+            '64M',
+            '-k',
+            '256M',
+            '-b',
+            'binary_buildpack',
+            '-c',
+            'sleep infinity',
+            '--health-check-type',
+            'process'
+        ]);
+        logger.info(`Tunnel app "${appName}" deployed successfully.`);
+    }
+    finally {
+        node_fs_1.default.rmSync(tmpDir, { recursive: true, force: true });
+    }
+}
+/**
+ * Enable SSH on a CF app and restart it.
+ *
+ * @param appName - CF app name.
+ * @param logger - Logger instance.
+ */
+async function enableSshAndRestart(appName, logger) {
+    logger.info(`Enabling SSH on "${appName}"...`);
+    await (0, cli_1.enableSsh)(appName);
+    logger.info(`Restarting "${appName}"...`);
+    await (0, cli_1.restartApp)(appName);
+}
+//# sourceMappingURL=ssh.js.map

package/dist/index.d.ts

@@ -6,6 +6,7 @@ export * from './source';
 export * from './ui5';
 export * from './base/cf';
 export * from './cf';
+export * from './btp';
 export * from './base/helper';
 export * from './base/credentials';
 export * from './base/constants';

package/dist/index.js

@@ -23,6 +23,7 @@ __exportStar(require("./source"), exports);
 __exportStar(require("./ui5"), exports);
 __exportStar(require("./base/cf"), exports);
 __exportStar(require("./cf"), exports);
+__exportStar(require("./btp"), exports);
 __exportStar(require("./base/helper"), exports);
 __exportStar(require("./base/credentials"), exports);
 __exportStar(require("./base/constants"), exports);

package/dist/translations/adp-tooling.i18n.json

@@ -114,7 +114,10 @@
         "noServiceInstanceNameFound": "No serviceInstanceName found in the app-variant-bundler-build configuration",
         "noServiceKeysFoundForInstance": "No service keys found for service instance: {{serviceInstanceName}}",
         "couldNotFetchServiceKeys": "Cannot fetch the service keys. Error: {{error}}",
-        "metadataFetchingNotSupportedForCF": "Metadata fetching is not supported for Cloud Foundry projects."
+        "metadataFetchingNotSupportedForCF": "Metadata fetching is not supported for Cloud Foundry projects.",
+        "cfPushFailed": "cf push failed for the '{{appName}}' app: {{error}}",
+        "cfEnableSshFailed": "cf enable-ssh failed for the '{{appName}}' app: {{error}}",
+        "cfRestartFailed": "cf restart failed for the '{{appName}}' app: {{error}}"
     },
     "choices": {
         "true": "true",

package/dist/types.d.ts

@@ -834,6 +834,22 @@ export interface ServiceKeyCredentialsWithTags {
     plan: string;
     credentials: ServiceKeys['credentials'] | undefined;
 }
+/**
+ * Destination configuration returned by the BTP Destination Configuration API.
+ * Contains the known properties; additional custom properties may also be present.
+ */
+export interface BtpDestinationConfig {
+    Name: string;
+    Type: string;
+    URL: string;
+    Authentication: string;
+    ProxyType: string;
+    Description?: string;
+    User?: string;
+    Password?: string;
+    'sap-client'?: string;
+    [key: string]: string | undefined;
+}
 export interface AppRouterEnvOptions {
     'VCAP_SERVICES'?: Record<string, unknown>;
     destinations?: {

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.112",
+  "version": "0.18.113",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",