feat: Extend add-new-model generator to support external services for CF projects

.changeset/selfish-monkeys-joke.md

@@ -0,0 +1,7 @@
+---
+"@sap-ux/adp-tooling": patch
+"@sap-ux/generator-adp": patch
+"@sap-ux/create": patch
+---
+
+feat: Extend add-new-model generator to support external services for CF projects

packages/adp-tooling/src/btp/api.ts

@@ -1,9 +1,10 @@
 import axios from 'axios';
 
 import type { ToolsLogger } from '@sap-ux/logger';
+import type { Destinations } from '@sap-ux/btp-utils';
 
 import { t } from '../i18n';
-import type { Uaa, BtpDestinationConfig } from '../types';
+import type { Uaa, BtpDestinationConfig, CfDestinationServiceCredentials } from '../types';
 
 /**
  * Obtain an OAuth2 access token using the client credentials grant.
@@ -27,8 +28,8 @@ export async function getToken(uaa: Uaa, logger?: ToolsLogger): Promise<string>
         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(t('error.failedToGetAuthKey', { error: e.message }));
+        logger?.error(`Failed to obtain OAuth token from ${uri}: ${e instanceof Error ? e.message : String(e)}`);
+        throw new Error(t('error.failedToGetAuthKey', { error: e instanceof Error ? e.message : String(e) }));
     }
 }
 
@@ -59,7 +60,43 @@ export async function getBtpDestinationConfig(
         logger?.debug(`Destination "${destinationName}" config: ProxyType=${config?.ProxyType}`);
         return config;
     } catch (e) {
-        logger?.error(`Failed to fetch destination config for "${destinationName}": ${e.message}`);
+        logger?.error(
+            `Failed to fetch destination config for "${destinationName}": ${e instanceof Error ? e.message : String(e)}`
+        );
         return undefined;
     }
 }
+
+/**
+ * Lists all subaccount destinations from the BTP Destination Configuration API.
+ *
+ * @param {CfDestinationServiceCredentials} credentials - Destination service credentials.
+ * @returns {Promise<Destinations>} Map of destination name to Destination object.
+ */
+export async function listBtpDestinations(credentials: CfDestinationServiceCredentials): Promise<Destinations> {
+    const uaa =
+        'uaa' in credentials
+            ? credentials.uaa
+            : { clientid: credentials.clientid, clientsecret: credentials.clientsecret, url: credentials.url };
+    const token = await getToken(uaa);
+    const url = `${credentials.uri}/destination-configuration/v1/subaccountDestinations`;
+    try {
+        const response = await axios.get<BtpDestinationConfig[]>(url, {
+            headers: { Authorization: `Bearer ${token}` }
+        });
+        const configs = Array.isArray(response.data) ? response.data : [];
+        return configs.reduce<Destinations>((acc, config) => {
+            acc[config.Name] = {
+                Name: config.Name,
+                Host: config.URL,
+                Type: config.Type,
+                Authentication: config.Authentication,
+                ProxyType: config.ProxyType,
+                Description: config.Description ?? ''
+            };
+            return acc;
+        }, {});
+    } catch (e) {
+        throw new Error(t('error.failedToListBtpDestinations', { error: e instanceof Error ? e.message : String(e) }));
+    }
+}

packages/adp-tooling/src/cf/project/yaml.ts

@@ -16,7 +16,7 @@ import type {
     ServiceKeys
 } from '../../types';
 import { AppRouterType } from '../../types';
-import { createServices } from '../services/api';
+import { createServices, createServiceInstance, getOrCreateServiceInstanceKeys } from '../services/api';
 import { getProjectNameForXsSecurity, getYamlContent } from './yaml-loader';
 import { getServiceKeyDestinations } from '../app/discovery';
 
@@ -44,6 +44,55 @@ export function isMtaProject(selectedPath: string): boolean {
     return fs.existsSync(path.join(selectedPath, 'mta.yaml'));
 }
 
+/**
+ * Adds a connectivity service resource to the project's mta.yaml if not already present,
+ * creates the CF service instance and generates a service key for it.
+ * Only applies to MTA projects. Required when the selected CF destination is OnPremise
+ * so the AppRouter can proxy requests through the Cloud Connector.
+ *
+ * @param {string} projectPath - The root path of the project.
+ * @param {Editor} memFs - The mem-fs editor instance.
+ * @param {ToolsLogger} [logger] - Optional logger.
+ */
+export async function addConnectivityServiceToMta(
+    projectPath: string,
+    memFs: Editor,
+    logger?: ToolsLogger
+): Promise<void> {
+    if (!isMtaProject(projectPath)) {
+        return;
+    }
+
+    const mtaYamlPath = path.join(projectPath, 'mta.yaml');
+    const yamlContent = getYamlContent<MtaYaml>(mtaYamlPath);
+    if (!yamlContent) {
+        return;
+    }
+
+    const projectName = yamlContent.ID.toLowerCase();
+    const connectivityResourceName = `${projectName}-connectivity`;
+
+    if (yamlContent.resources?.some((r: MtaResource) => r.name === connectivityResourceName)) {
+        return;
+    }
+
+    await createServiceInstance('lite', connectivityResourceName, 'connectivity', { logger });
+    await getOrCreateServiceInstanceKeys({ names: [connectivityResourceName] }, logger);
+
+    yamlContent.resources = yamlContent.resources ?? [];
+    yamlContent.resources.push({
+        name: connectivityResourceName,
+        type: CF_MANAGED_SERVICE,
+        parameters: {
+            service: 'connectivity',
+            'service-plan': 'lite',
+            'service-name': connectivityResourceName
+        }
+    });
+
+    memFs.write(mtaYamlPath, yaml.dump(yamlContent, { lineWidth: -1 }));
+}
+
 /**
  * Gets the SAP Cloud Service.
  *

packages/adp-tooling/src/cf/services/destinations.ts

@@ -0,0 +1,49 @@
+import * as path from 'node:path';
+
+import type { Destinations } from '@sap-ux/btp-utils';
+
+import { getOrCreateServiceInstanceKeys } from './api';
+import { listBtpDestinations } from '../../btp/api';
+import { getYamlContent } from '../project/yaml-loader';
+import { t } from '../../i18n';
+import type { CfDestinationServiceCredentials, MtaYaml } from '../../types';
+
+/**
+ * Finds the name of the destination service instance declared in the MTA project's mta.yaml.
+ *
+ * @param {string} projectPath - The root path of the app project.
+ * @returns {string} The CF service instance name.
+ * @throws {Error} When the destination service instance is not found or mta.yaml cannot be read.
+ */
+function getDestinationServiceName(projectPath: string): string {
+    try {
+        const yamlContent = getYamlContent<MtaYaml>(path.join(path.dirname(projectPath), 'mta.yaml'));
+        const name = yamlContent?.resources?.find((r) => r.parameters?.service === 'destination')?.name;
+        if (!name) {
+            throw new Error(t('error.destinationServiceNotFoundInMtaYaml'));
+        }
+        return name;
+    } catch (e) {
+        throw e instanceof Error ? e : new Error(t('error.destinationServiceNotFoundInMtaYaml'));
+    }
+}
+
+/**
+ * Returns the list of available BTP destinations from the logged-in CF subaccount.
+ * Reads the destination service credentials from the CF project's service keys
+ * and calls the BTP Destination Configuration API directly.
+ *
+ * @param {string} projectPath - The root path of the CF app project.
+ * @returns {Promise<Destinations>} Map of destination name to Destination object.
+ */
+export async function getBtpDestinations(projectPath: string): Promise<Destinations> {
+    const destinationServiceName = getDestinationServiceName(projectPath);
+
+    const serviceInfo = await getOrCreateServiceInstanceKeys({ names: [destinationServiceName] });
+    if (!serviceInfo?.serviceKeys?.length) {
+        throw new Error(t('error.noServiceKeysFoundForDestination', { serviceInstanceName: destinationServiceName }));
+    }
+
+    const credentials = serviceInfo.serviceKeys[0].credentials as CfDestinationServiceCredentials;
+    return listBtpDestinations(credentials);
+}

packages/adp-tooling/src/cf/services/index.ts

@@ -1,4 +1,5 @@
 export * from './api';
 export * from './ssh';
 export * from './cli';
+export * from './destinations';
 export * from './manifest';