@sap-ux/adp-tooling 0.18.93 → 0.18.95

package/dist/base/abap/manifest-service.d.ts

@@ -1,8 +1,7 @@
 import type { ToolsLogger } from '@sap-ux/logger';
 import type { Manifest, ManifestNamespace } from '@sap-ux/project-access';
 import { type AbapServiceProvider } from '@sap-ux/axios-extension';
-import type { DescriptorVariant } from '../../types';
-export type DataSources = Record<string, ManifestNamespace.DataSource>;
+import type { DescriptorVariant, IManifestService, DataSources } from '../../types';
 /**
  * Retrieves the inbound navigation configurations from the project's manifest.
  *
@@ -23,7 +22,7 @@ export declare function getRegistrationIdFromManifest(manifest: Manifest): strin
  * It provides methods to fetch the manifest, data sources and metadata of a data source.
  *
  */
-export declare class ManifestService {
+export declare class ManifestService implements IManifestService {
     private readonly provider;
     private readonly logger;
     private manifest;

package/dist/cf/project/yaml.js

@@ -105,7 +105,7 @@ function getAppParamsFromUI5Yaml(projectPath) {
     const appConfiguration = parsedYaml?.builder?.customTasks?.[0]?.configuration;
     const appParams = {
         appHostId: appConfiguration?.appHostId || '',
-        appName: appConfiguration?.appVersion || '',
+        appName: appConfiguration?.appName || '',
         appVersion: appConfiguration?.appVersion || '',
         spaceGuid: appConfiguration?.space || ''
     };

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

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

package/dist/cf/services/index.js

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

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

@@ -0,0 +1,52 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { Manifest } from '@sap-ux/project-access';
+import type { IManifestService, DataSources } from '../../types';
+/**
+ * Service class for handling operations related to the manifest of a CF-deployed UI5 application.
+ * Extends the ABAP {@link ManifestService} API, but retrieves the manifest from the local
+ * build output (`dist/`)
+ *
+ * The build is triggered automatically during initialization so that the `dist/` folder
+ * contains the latest merged manifest before it is read.
+ */
+export declare class ManifestServiceCF implements IManifestService {
+    private readonly logger;
+    private manifest;
+    /**
+     * Private constructor to initialize the ManifestServiceCF.
+     *
+     * @param logger - The logger instance.
+     */
+    private constructor();
+    /**
+     * Creates an instance of the ManifestServiceCF by building the project and
+     * reading the manifest from the `dist/` folder.
+     *
+     * @param projectPath - The path to the adaptation project.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestServiceCF.
+     */
+    static init(projectPath: string, logger: ToolsLogger): Promise<ManifestServiceCF>;
+    /**
+     * Returns the manifest read from the build output during initialization.
+     *
+     * @returns The current manifest.
+     */
+    getManifest(): Manifest;
+    /**
+     * Returns the data sources from the manifest.
+     *
+     * @returns The data sources from the manifest.
+     * @throws Error if no data sources are found in the manifest.
+     */
+    getManifestDataSources(): DataSources;
+    /**
+     * Metadata fetching is not supported for CF projects because there is no ABAP service provider
+     * to proxy the OData metadata request. Consumers should handle this gracefully.
+     *
+     * @param _dataSourceId - The ID of the data source (unused).
+     * @throws Error indicating metadata fetching is not supported for CF projects.
+     */
+    getDataSourceMetadata(_dataSourceId: string): Promise<string>;
+}
+//# sourceMappingURL=manifest.d.ts.map

package/dist/cf/services/manifest.js

@@ -0,0 +1,84 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ManifestServiceCF = void 0;
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const project_builder_1 = require("../../base/project-builder");
+const i18n_1 = require("../../i18n");
+/** Default build output folder used by CF ADP projects. */
+const CF_BUILD_PATH = 'dist';
+/**
+ * Service class for handling operations related to the manifest of a CF-deployed UI5 application.
+ * Extends the ABAP {@link ManifestService} API, but retrieves the manifest from the local
+ * build output (`dist/`)
+ *
+ * The build is triggered automatically during initialization so that the `dist/` folder
+ * contains the latest merged manifest before it is read.
+ */
+class ManifestServiceCF {
+    logger;
+    manifest;
+    /**
+     * Private constructor to initialize the ManifestServiceCF.
+     *
+     * @param logger - The logger instance.
+     */
+    constructor(logger) {
+        this.logger = logger;
+    }
+    /**
+     * Creates an instance of the ManifestServiceCF by building the project and
+     * reading the manifest from the `dist/` folder.
+     *
+     * @param projectPath - The path to the adaptation project.
+     * @param logger - The logger instance.
+     * @returns A promise that resolves to an instance of ManifestServiceCF.
+     */
+    static async init(projectPath, logger) {
+        const service = new ManifestServiceCF(logger);
+        logger.debug('Triggering project build to generate dist folder');
+        await (0, project_builder_1.runBuild)(projectPath, { ADP_BUILDER_MODE: 'preview' });
+        const manifestPath = (0, node_path_1.join)(projectPath, CF_BUILD_PATH, 'manifest.json');
+        logger.debug(`Reading manifest from '${manifestPath}'`);
+        const manifestContent = (0, node_fs_1.readFileSync)(manifestPath, 'utf-8');
+        service.manifest = JSON.parse(manifestContent);
+        logger.debug('Manifest successfully read from dist folder');
+        return service;
+    }
+    /**
+     * Returns the manifest read from the build output during initialization.
+     *
+     * @returns The current manifest.
+     */
+    getManifest() {
+        return this.manifest;
+    }
+    /**
+     * Returns the data sources from the manifest.
+     *
+     * @returns The data sources from the manifest.
+     * @throws Error if no data sources are found in the manifest.
+     */
+    getManifestDataSources() {
+        const dataSources = this.manifest['sap.app'].dataSources;
+        if (!dataSources) {
+            throw new Error('No data sources found in the manifest');
+        }
+        this.logger.debug(`Found ${Object.keys(dataSources).length} data source(s) in manifest`);
+        return dataSources;
+    }
+    /**
+     * Metadata fetching is not supported for CF projects because there is no ABAP service provider
+     * to proxy the OData metadata request. Consumers should handle this gracefully.
+     *
+     * @param _dataSourceId - The ID of the data source (unused).
+     * @throws Error indicating metadata fetching is not supported for CF projects.
+     */
+    async getDataSourceMetadata(_dataSourceId) {
+        const message = (0, i18n_1.t)('error.metadataFetchingNotSupportedForCF');
+        this.logger.warn(message);
+        throw new Error(message);
+    }
+}
+exports.ManifestServiceCF = ManifestServiceCF;
+//# sourceMappingURL=manifest.js.map

package/dist/preview/adp-preview.d.ts

@@ -13,7 +13,9 @@ export declare const enum ApiRoutes {
     FRAGMENT = "/adp/api/fragment",
     CONTROLLER = "/adp/api/controller",
     CODE_EXT = "/adp/api/code_ext",
-    ANNOTATION = "/adp/api/annotation"
+    ANNOTATION = "/adp/api/annotation",
+    OVP_DATA_SOURCES = "/adp/api/ovp/datasources",
+    OVP_METAMODEL = "/adp/api/ovp/metamodel"
 }
 /**
  * Instance of an adaptation project handling requests and data transformation.
@@ -35,6 +37,10 @@ export declare class AdpPreview {
      * Routes handler class to handle API requests
      */
     private routesHandler;
+    /**
+     * Routes handler for OVP bridge functions
+     */
+    private ovpRoutesHandler;
     private lrep;
     private descriptorVariantId;
     private projectTypeValue?;

package/dist/preview/adp-preview.js

@@ -7,6 +7,7 @@ exports.AdpPreview = void 0;
 const adm_zip_1 = __importDefault(require("adm-zip"));
 const system_access_1 = require("@sap-ux/system-access");
 const routes_handler_1 = __importDefault(require("./routes-handler"));
+const ovp_routes_handler_1 = __importDefault(require("./ovp-routes-handler"));
 const change_handler_1 = require("./change-handler");
 const descriptor_change_handler_1 = require("./descriptor-change-handler");
 const helper_1 = require("../base/helper");
@@ -31,6 +32,10 @@ class AdpPreview {
      * Routes handler class to handle API requests
      */
     routesHandler;
+    /**
+     * Routes handler for OVP bridge functions
+     */
+    ovpRoutesHandler;
     lrep;
     descriptorVariantId;
     projectTypeValue;
@@ -102,6 +107,7 @@ class AdpPreview {
         this.descriptorVariantId = descriptorVariant.id;
         this.provider = await (0, system_access_1.createAbapServiceProvider)(this.config.target, { ignoreCertErrors: this.config.ignoreCertErrors }, true, this.logger);
         this.routesHandler = new routes_handler_1.default(this.project, this.util, this.provider, this.logger);
+        this.ovpRoutesHandler = new ovp_routes_handler_1.default(this.provider, this.logger);
         this.lrep = this.provider.getLayeredRepository();
         // fetch a merged descriptor from the backend
         await this.lrep.getCsrfToken();
@@ -205,6 +211,10 @@ class AdpPreview {
         router.post("/adp/api/controller" /* ApiRoutes.CONTROLLER */, this.routesHandler.handleWriteControllerExt);
         router.get("/adp/api/code_ext" /* ApiRoutes.CODE_EXT */, this.routesHandler.handleGetControllerExtensionData);
         router.get("/adp/api/annotation" /* ApiRoutes.ANNOTATION */, this.routesHandler.handleGetAllAnnotationFilesMappedByDataSource);
+        if (this.ovpRoutesHandler) {
+            router.get("/adp/api/ovp/datasources" /* ApiRoutes.OVP_DATA_SOURCES */, this.ovpRoutesHandler.handleGetDataSources);
+            router.post("/adp/api/ovp/metamodel" /* ApiRoutes.OVP_METAMODEL */, this.ovpRoutesHandler.handleGetMetaModel);
+        }
     }
     /**
      * Handles different types of change requests to project files.

package/dist/preview/ovp-routes-handler.d.ts

@@ -0,0 +1,38 @@
+import type { ToolsLogger } from '@sap-ux/logger';
+import type { NextFunction, Request, Response } from 'express';
+import type { AbapServiceProvider } from '@sap-ux/axios-extension';
+/**
+ * Server-side handler for OVP bridge function API routes.
+ * Provides data source catalog and service metadata endpoints
+ * consumed by the client-side OVP bridge functions.
+ */
+export default class OvpRoutesHandler {
+    private readonly provider;
+    private readonly logger;
+    /**
+     * Creates an instance of OvpRoutesHandler.
+     *
+     * @param provider AbapServiceProvider instance for backend communication
+     * @param logger Logger instance
+     */
+    constructor(provider: AbapServiceProvider, logger: ToolsLogger);
+    /**
+     * Handler for fetching available OData V2 services from the catalog.
+     *
+     * @param _req Request
+     * @param res Response
+     * @param next Next function
+     */
+    handleGetDataSources: (_req: Request, res: Response, next: NextFunction) => Promise<void>;
+    /**
+     * Handler for fetching service info and annotation URLs for a selected data source.
+     * Returns the service URL and annotation details so the client can create
+     * a real UI5 ODataModel with annotations merged for full metamodel support.
+     *
+     * @param req Request containing dataSource in body
+     * @param res Response
+     * @param next Next function
+     */
+    handleGetMetaModel: (req: Request, res: Response, next: NextFunction) => Promise<void>;
+}
+//# sourceMappingURL=ovp-routes-handler.d.ts.map

package/dist/preview/ovp-routes-handler.js

@@ -0,0 +1,113 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const axios_extension_1 = require("@sap-ux/axios-extension");
+/**
+ * Converts an absolute URL to a relative path.
+ * Annotation URIs from the catalog service are absolute (e.g. https://host/sap/opu/...).
+ * The client needs relative paths so requests go through the backend proxy.
+ *
+ * @param uri Absolute or relative URI
+ * @returns Relative path
+ */
+function toRelativePath(uri) {
+    try {
+        return new URL(uri).pathname;
+    }
+    catch {
+        return uri;
+    }
+}
+/**
+ * Server-side handler for OVP bridge function API routes.
+ * Provides data source catalog and service metadata endpoints
+ * consumed by the client-side OVP bridge functions.
+ */
+class OvpRoutesHandler {
+    provider;
+    logger;
+    /**
+     * Creates an instance of OvpRoutesHandler.
+     *
+     * @param provider AbapServiceProvider instance for backend communication
+     * @param logger Logger instance
+     */
+    constructor(provider, logger) {
+        this.provider = provider;
+        this.logger = logger;
+    }
+    /**
+     * Handler for fetching available OData V2 services from the catalog.
+     *
+     * @param _req Request
+     * @param res Response
+     * @param next Next function
+     */
+    handleGetDataSources = async (_req, res, next) => {
+        try {
+            const catalogService = this.provider.catalog(axios_extension_1.ODataVersion.v2);
+            const response = await catalogService.get('/ServiceCollection', {
+                params: { $format: 'json' }
+            });
+            const services = response.odata();
+            res.status(200 /* HttpStatusCodes.OK */).json({ results: services });
+            this.logger.debug(`OVP: Fetched ${services.length} data sources from catalog`);
+        }
+        catch (e) {
+            this.logger.error(`OVP: Failed to fetch data sources: ${e.message}`);
+            res.status(500 /* HttpStatusCodes.INTERNAL_SERVER_ERROR */).json({
+                message: `Failed to fetch data sources: ${e.message}`
+            });
+            next(e);
+        }
+    };
+    /**
+     * Handler for fetching service info and annotation URLs for a selected data source.
+     * Returns the service URL and annotation details so the client can create
+     * a real UI5 ODataModel with annotations merged for full metamodel support.
+     *
+     * @param req Request containing dataSource in body
+     * @param res Response
+     * @param next Next function
+     */
+    handleGetMetaModel = async (req, res, next) => {
+        try {
+            const { dataSource } = req.body;
+            this.logger.debug(`OVP: getMetaModel called for service ${dataSource?.Title ?? 'unknown'}`);
+            if (!dataSource?.Title) {
+                res.status(400 /* HttpStatusCodes.BAD_REQUEST */).json({ message: 'dataSource with Title is required' });
+                return;
+            }
+            const catalogService = this.provider.catalog(axios_extension_1.ODataVersion.v2);
+            const filterOptions = dataSource.ID ? { id: dataSource.ID } : { title: dataSource.Title };
+            const annotations = await catalogService.getAnnotations(filterOptions);
+            if (annotations.length === 0) {
+                res.status(200 /* HttpStatusCodes.OK */).json(null);
+                this.logger.debug(`OVP: No annotations found for service ${dataSource.Title}`);
+                return;
+            }
+            const serviceURI = `/sap/opu/odata/sap/${dataSource.Title}`;
+            res.status(200 /* HttpStatusCodes.OK */).json({
+                serviceUrl: `${serviceURI}/`,
+                annotations: annotations.map((a) => ({
+                    TechnicalName: a.TechnicalName,
+                    Uri: toRelativePath(a.Uri)
+                })),
+                modelInformation: {
+                    serviceURI,
+                    serviceAnnotation: annotations[0].TechnicalName,
+                    serviceAnnotationURI: toRelativePath(annotations[0].Uri)
+                }
+            });
+            this.logger.debug(`OVP: Fetched service info for ${dataSource.Title} with ${annotations.length} annotations`);
+        }
+        catch (e) {
+            this.logger.error(`OVP: Failed to fetch metamodel: ${e.message}`);
+            res.status(500 /* HttpStatusCodes.INTERNAL_SERVER_ERROR */).json({
+                message: `Failed to fetch metamodel: ${e.message}`
+            });
+            next(e);
+        }
+    };
+}
+exports.default = OvpRoutesHandler;
+//# sourceMappingURL=ovp-routes-handler.js.map

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

@@ -111,7 +111,8 @@
         "xsAppJsonNotFound": "The xs-app.json file was not found in any of the expected locations: {{paths}}",
         "noServiceInstanceNameFound": "No serviceInstanceName found in the app-variant-bundler-build configuration",
         "noServiceKeysFoundForInstance": "No service keys found for service instance: {{serviceInstanceName}}",
-        "couldNotFetchServiceKeys": "Could not fetch the service keys: {{error}}"
+        "couldNotFetchServiceKeys": "Cannot fetch the service keys. Error: {{error}}",
+        "metadataFetchingNotSupportedForCF": "Metadata fetching is not supported for Cloud Foundry projects."
     },
     "choices": {
         "true": "true",

package/dist/types.d.ts

@@ -7,6 +7,32 @@ import type { Destination } from '@sap-ux/btp-utils';
 import type { YUIQuestion } from '@sap-ux/inquirer-common';
 import type AdmZip from 'adm-zip';
 import type { SupportedProject } from './source';
+export type DataSources = Record<string, ManifestNamespace.DataSource>;
+/**
+ * Common interface for manifest services (ABAP and CF).
+ * Consumers should program against this interface to support both environments.
+ */
+export interface IManifestService {
+    /**
+     * Returns the manifest.
+     *
+     * @returns The manifest.
+     */
+    getManifest(): Manifest;
+    /**
+     * Returns the data sources from the manifest.
+     *
+     * @returns The data sources from the manifest.
+     */
+    getManifestDataSources(): DataSources;
+    /**
+     * Returns the metadata of a data source.
+     *
+     * @param dataSourceId - The ID of the data source.
+     * @returns A promise that resolves to the metadata of the data source.
+     */
+    getDataSourceMetadata(dataSourceId: string): Promise<string>;
+}
 export interface DescriptorVariant {
     layer: UI5FlexLayer;
     reference: string;

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