feat: Enable Adaptation Editor for CF projects

packages/adp-tooling/src/base/helper.ts

@@ -6,7 +6,7 @@ import type { UI5Config } from '@sap-ux/ui5-config';
 import type { InboundContent, Inbound } from '@sap-ux/axios-extension';
 import { getWebappPath, FileName, readUi5Yaml, type ManifestNamespace } from '@sap-ux/project-access';
 
-import type { DescriptorVariant, AdpPreviewConfig } from '../types';
+import type { DescriptorVariant, AdpPreviewConfig, UI5YamlCustomTaskConfiguration } from '../types';
 
 /**
  * Get the app descriptor variant.
@@ -86,6 +86,23 @@ export function extractAdpConfig(ui5Conf: UI5Config): AdpPreviewConfig | undefin
     return customMiddleware?.configuration?.adp;
 }
 
+/**
+ * Extracts the CF build task from the UI5 configuration.
+ *
+ * @param {UI5Config} ui5Conf - The UI5 configuration.
+ * @returns {UI5YamlCustomTaskConfiguration} The CF build task.
+ */
+export function extractCfBuildTask(ui5Conf: UI5Config): UI5YamlCustomTaskConfiguration {
+    const buildTask =
+        ui5Conf.findCustomTask<UI5YamlCustomTaskConfiguration>('app-variant-bundler-build')?.configuration;
+
+    if (!buildTask) {
+        throw new Error('No CF ADP project found');
+    }
+
+    return buildTask;
+}
+
 /**
  * Convenience wrapper that reads the ui5.yaml and directly returns the ADP preview configuration.
  * Throws if the configuration cannot be found.

packages/adp-tooling/src/cf/app/discovery.ts

@@ -1,8 +1,11 @@
+import type AdmZip from 'adm-zip';
+
 import type { ToolsLogger } from '@sap-ux/logger';
 
 import { t } from '../../i18n';
+import { extractXSApp } from '../utils';
 import { getFDCApps } from '../services/api';
-import type { CfConfig, CFApp, ServiceKeys } from '../../types';
+import type { CfConfig, CFApp, ServiceKeys, XsApp } from '../../types';
 
 /**
  * Get the app host ids.
@@ -25,6 +28,69 @@
     return [...new Set(appHostIds)];
 }
 
+/**
+ * Extracts the backend URL from service key credentials. Iterates through all endpoint keys to find the first endpoint with a URL.
+ *
+ * @param {ServiceKeys[]} serviceKeys - The credentials from service keys.
+ * @returns {string | undefined} The backend URL or undefined if not found.
+ */
+export function getBackendUrlFromServiceKeys(serviceKeys: ServiceKeys[]): string | undefined {
+    if (!serviceKeys || serviceKeys.length === 0) {
+        return undefined;
+    }
+
+    const endpoints = serviceKeys[0]?.credentials?.endpoints as Record<string, { url?: string }> | undefined;
+    if (endpoints && typeof endpoints === 'object' && endpoints !== null) {
+        for (const key in endpoints) {
+            if (Object.prototype.hasOwnProperty.call(endpoints, key)) {
+                const endpoint = endpoints[key] as { url?: string } | undefined;
+                if (endpoint && typeof endpoint === 'object' && endpoint.url && typeof endpoint.url === 'string') {
+                    return endpoint.url;
+                }
+            }
+        }
+    }
+
+    return undefined;
+}
+
+/**
+ * Extracts OAuth paths from xs-app.json routes that have a source property.
+ * These paths should receive OAuth Bearer tokens in the middleware.
+ *
+ * @param {AdmZip.IZipEntry[]} zipEntries - The zip entries containing xs-app.json.
+ * @returns {string[]} Array of path patterns (from route.source) that have a source property.
+ */
+export function getOAuthPathsFromXsApp(zipEntries: AdmZip.IZipEntry[]): string[] {
+    const xsApp: XsApp | undefined = extractXSApp(zipEntries);
+    if (!xsApp?.routes) {
+        return [];
+    }
+
+    const pathsSet = new Set<string>();
+    for (const route of xsApp.routes) {
+        if (route.service === 'html5-apps-repo-rt' || !route.source) {
+            continue;
+        }
+
+        let path = route.source;
+        // Remove leading ^ and trailing $
+        path = path.replace(/^\^/, '').replace(/\$$/, '');
+        // Remove capture groups like (.*) or $1
+        path = path.replace(/\([^)]*\)/g, '');
+        // Remove regex quantifiers
+        path = path.replace(/\$\d+/g, '');
+        // Clean up any remaining regex characters at the end
+        path = path.replace(/\/?\*$/, '');
+
+        if (path) {
+            pathsSet.add(path);
+        }
+    }
+
+    return Array.from(pathsSet);
+}
+
 /**
  * Discover apps from FDC API based on credentials.
  *

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

@@ -315,7 +315,10 @@ async function getServiceInstance(params: GetServiceInstanceParams): Promise<Ser
  * @param {ToolsLogger} logger - The logger.
  * @returns {Promise<ServiceKeys[]>} The service instance keys.
  */
-async function getOrCreateServiceKeys(serviceInstance: ServiceInstance, logger: ToolsLogger): Promise<ServiceKeys[]> {
+export async function getOrCreateServiceKeys(
+    serviceInstance: ServiceInstance,
+    logger: ToolsLogger
+): Promise<ServiceKeys[]> {
     const serviceInstanceName = serviceInstance.name;
     try {
         const credentials = await getServiceKeys(serviceInstance.guid);

packages/adp-tooling/src/preview/adp-preview.ts

@@ -129,10 +129,14 @@ export class AdpPreview {
     /**
      * Fetch all required configurations from the backend and initialize all configurations.
      *
-     * @param descriptorVariant descriptor variant from the project
-     * @returns the UI5 flex layer for which editing is enabled
+     * @param {DescriptorVariant} descriptorVariant - Descriptor variant from the project.
+     * @returns {Promise<UI5FlexLayer>} The UI5 flex layer for which editing is enabled.
      */
     async init(descriptorVariant: DescriptorVariant): Promise<UI5FlexLayer> {
+        if (this.config.useLocal) {
+            return this.initLocal(descriptorVariant);
+        }
+
         this.descriptorVariantId = descriptorVariant.id;
         this.provider = await createAbapServiceProvider(
             this.config.target,
@@ -152,11 +156,27 @@ export class AdpPreview {
         return descriptorVariant.layer;
     }
 
+    /**
+     * Initialize the preview for a local CF ADP project.
+     *
+     * @param descriptorVariant descriptor variant from the project
+     * @returns the UI5 flex layer for which editing is enabled
+     */
+    private async initLocal(descriptorVariant: DescriptorVariant): Promise<UI5FlexLayer> {
+        this.descriptorVariantId = descriptorVariant.id;
+        this.isCloud = false;
+        this.routesHandler = new RoutesHandler(this.project, this.util, {} as AbapServiceProvider, this.logger);
+        return descriptorVariant.layer;
+    }
+
     /**
      * Synchronize local changes with the backend.
      * The descriptor is refreshed only if the global flag is set to true.
      */
     async sync(): Promise<void> {
+        if (this.config.useLocal) {
+            return;
+        }
         if (!global.__SAP_UX_MANIFEST_SYNC_REQUIRED__ && this.mergedDescriptor) {
             return;
         }

packages/adp-tooling/src/preview/routes-handler.ts

@@ -47,6 +47,11 @@ type ControllerInfo = { controllerName: string };
  * @description Handles API Routes
  */
 export default class RoutesHandler {
+    /**
+     * Whether this is running in local mode (CF ADP without backend).
+     */
+    private readonly isLocalMode: boolean;
+
     /**
      * Constructor taking project as input.
      *
@@ -60,7 +65,9 @@ export default class RoutesHandler {
         private readonly util: MiddlewareUtils,
         private readonly provider: AbapServiceProvider,
         private readonly logger: ToolsLogger
-    ) {}
+    ) {
+        this.isLocalMode = !provider || typeof provider.getLayeredRepository !== 'function';
+    }
 
     /**
      * Reads files from workspace by given search pattern.
@@ -288,6 +295,16 @@ export default class RoutesHandler {
         try {
             const isRunningInBAS = isAppStudio();
 
+            if (this.isLocalMode) {
+                // In local mode (CF ADP), skip ManifestService as it requires ABAP backend
+                const apiResponse: AnnotationDataSourceResponse = {
+                    isRunningInBAS,
+                    annotationDataSourceMap: {}
+                };
+                this.sendFilesResponse(res, apiResponse);
+                return;
+            }
+
             const manifestService = await this.getManifestService();
             const dataSources = manifestService.getManifestDataSources();
             const apiResponse: AnnotationDataSourceResponse = {

packages/adp-tooling/src/types.ts

@@ -39,6 +39,10 @@ export interface AdpPreviewConfig {
      * If set to true then certification validation errors are ignored.
      */
     ignoreCertErrors?: boolean;
+    /**
+     * For CF ADP projects: when set to 'dist', serve resources from local dist instead of backend merge.
+     */
+    useLocal?: string;
 }
 
 export interface OnpremApp {
@@ -881,6 +885,8 @@ export interface UI5YamlCustomTaskConfiguration {
     space: string;
     html5RepoRuntime: string;
     sapCloudService: string;
+    serviceInstanceName: string;
+    serviceInstanceGuid: string;
 }
 
 export interface UI5YamlCustomTask {
@@ -1036,6 +1042,18 @@ export interface CfAdpWriterConfig {
         approuter: AppRouterType;
         businessService: string;
         businessSolutionName?: string;
+        /**
+         * GUID of the business service instance.
+         */
+        serviceInstanceGuid?: string;
+        /**
+         * Backend URL from service instance keys.
+         */
+        backendUrl?: string;
+        /**
+         * OAuth paths extracted from xs-app.json routes that have a source property.
+         */
+        oauthPaths?: string[];
     };
     project: {
         name: string;
@@ -1065,6 +1083,9 @@ export interface CreateCfConfigParams {
     layer: FlexLayer;
     manifest: Manifest;
     html5RepoRuntimeGuid: string;
+    serviceInstanceGuid?: string;
+    backendUrl?: string;
+    oauthPaths?: string[];
     projectPath: string;
     addStandaloneApprouter?: boolean;
     publicVersions: UI5Version;
@@ -1134,7 +1155,6 @@ export interface CFApp {
     messages?: string[];
     serviceInstanceGuid?: string;
 }
-
 /**
  * CF services (application sources) prompts
  */

packages/adp-tooling/src/writer/cf.ts

@@ -7,7 +7,7 @@ import { adjustMtaYaml } from '../cf';
 import { getApplicationType } from '../source';
 import { fillDescriptorContent } from './manifest';
 import type { CfAdpWriterConfig, Content } from '../types';
-import { getCfVariant, writeCfTemplates, writeCfUI5Yaml, writeCfUI5BuildYaml } from './project-utils';
+import { getCfVariant, writeCfTemplates, writeCfUI5Yaml } from './project-utils';
 import { getI18nDescription, getI18nModels, writeI18nModels } from './i18n';
 
 /**
@@ -54,7 +54,6 @@ export async function generateCf(
 
     await writeCfTemplates(basePath, variant, fullConfig, fs);
     await writeCfUI5Yaml(fullConfig.project.folder, fullConfig, fs);
-    await writeCfUI5BuildYaml(fullConfig.project.folder, fullConfig, fs);
 
     return fs;
 }

packages/adp-tooling/src/writer/options.ts

@@ -365,7 +365,8 @@ export function enhanceUI5YamlWithCfCustomTask(ui5Config: UI5Config, config: CfA
                 org: cf.org.GUID,
                 space: cf.space.GUID,
                 sapCloudService: cf.businessSolutionName ?? '',
-                serviceInstanceName: cf.businessService
+                serviceInstanceName: cf.businessService,
+                serviceInstanceGuid: cf.serviceInstanceGuid
             }
         }
     ]);
@@ -375,26 +376,52 @@ export function enhanceUI5YamlWithCfCustomTask(ui5Config: UI5Config, config: CfA
  * Generate custom configuration required for the ui5.yaml.
  *
  * @param {UI5Config} ui5Config - Configuration representing the ui5.yaml.
+ * @param {CfAdpWriterConfig} config - Full project configuration.
  */
-export function enhanceUI5YamlWithCfCustomMiddleware(ui5Config: UI5Config): void {
+export function enhanceUI5YamlWithCfCustomMiddleware(ui5Config: UI5Config, config: CfAdpWriterConfig): void {
     const ui5ConfigOptions: Partial<FioriToolsProxyConfigUI5> = {
         url: UI5_CDN_URL
     };
 
-    ui5Config.addFioriToolsProxyMiddleware(
-        {
-            ui5: ui5ConfigOptions,
-            backend: []
-        },
-        'compression'
-    );
+    const oauthPaths = config.cf?.oauthPaths;
+    const backendUrl = config.cf?.backendUrl;
+    if (oauthPaths && oauthPaths.length > 0 && backendUrl) {
+        ui5Config.addCustomMiddleware([
+            {
+                name: 'backend-proxy-middleware-cf',
+                afterMiddleware: 'compression',
+                configuration: {
+                    url: backendUrl,
+                    paths: oauthPaths
+                }
+            }
+        ]);
+        ui5Config.addFioriToolsProxyMiddleware(
+            {
+                ui5: ui5ConfigOptions,
+                backend: []
+            },
+            'backend-proxy-middleware-cf'
+        );
+    } else {
+        ui5Config.addFioriToolsProxyMiddleware(
+            {
+                ui5: ui5ConfigOptions,
+                backend: []
+            },
+            'compression'
+        );
+    }
     ui5Config.addCustomMiddleware([
         {
             name: 'fiori-tools-preview',
             afterMiddleware: 'fiori-tools-proxy',
             configuration: {
                 flp: {
                     theme: 'sap_horizon'
+                },
+                adp: {
+                    useLocal: 'dist'
                 }
             }
         }