@sap-ux/adp-tooling 0.18.92 → 0.18.94

package/dist/base/change-utils.js

@@ -18,6 +18,7 @@ const node_fs_1 = require("node:fs");
 const project_access_1 = require("@sap-ux/project-access");
 const types_1 = require("../types");
 const ejs_1 = require("ejs");
+const key_user_translations_1 = require("../writer/i18n/key-user-translations");
 /**
  * Writes annotation changes to the specified project path using the provided `mem-fs-editor` instance.
  *
@@ -83,6 +84,14 @@ async function writeKeyUserChanges(projectPath, config, fs) {
         if (!change['fileName']) {
             continue;
         }
+        const fileName = change['fileName'];
+        const contentTexts = change['texts'];
+        const topLevelTexts = entry.texts;
+        // Replace content.texts values with i18n bindings and write translations to .properties files
+        if (contentTexts && topLevelTexts && Object.keys(topLevelTexts).length > 0) {
+            change['texts'] = (0, key_user_translations_1.replaceTextsWithI18nBindings)(contentTexts, fileName);
+            await (0, key_user_translations_1.writeKeyUserTranslations)(projectPath, fileName, topLevelTexts, fs);
+        }
         const transformedChange = transformKeyUserChangeForAdp(change, config.app.id, config.app.layer);
         await writeChangeToFolder(projectPath, transformedChange, fs);
     }

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/writer/i18n/key-user-translations.d.ts

@@ -0,0 +1,33 @@
+import type { Editor } from 'mem-fs-editor';
+import type { KeyUserTextTranslations } from '@sap-ux/axios-extension';
+/**
+ * Normalizes a backend language key to the locale suffix used in i18n .properties file names.
+ *
+ * The backend (LRep) already normalizes language keys to ISO 639 via T002/T002X lookup,
+ * so this function primarily converts BCP47 separators (`-`) to underscores (`_`) for
+ * .properties file naming and applies old-to-new ISO 639 mapping as a safety net.
+ *
+ * @param lang - Language key from the backend response (e.g., '', 'en', 'iw', 'pt-BR', 'zh-Hans').
+ * @returns The normalized locale suffix for .properties file naming (e.g., '', 'en', 'he', 'pt_BR', 'zh_Hans').
+ */
+export declare function normalizeLanguageForI18n(lang: string): string;
+/**
+ * Replaces the `value` property of each entry in `content.texts` with an i18n binding expression.
+ * The generated key follows the pattern `<fileName>_<textId>`.
+ *
+ * @param contentTexts - The `texts` object from inside the change content.
+ * @param fileName - The file name of the change, used as key prefix.
+ * @returns The modified texts object with i18n bindings replacing values.
+ */
+export declare function replaceTextsWithI18nBindings(contentTexts: Record<string, Record<string, unknown>>, fileName: string): Record<string, Record<string, unknown>>;
+/**
+ * Writes translations from the top-level `texts` object of a key-user change
+ * into the project's i18n .properties files.
+ *
+ * @param projectPath - The root path of the project.
+ * @param fileName - The file name of the change, used as key prefix.
+ * @param topLevelTexts - The top-level `texts` object from the API response entry.
+ * @param fs - The `mem-fs-editor` instance used for file operations.
+ */
+export declare function writeKeyUserTranslations(projectPath: string, fileName: string, topLevelTexts: KeyUserTextTranslations, fs: Editor): Promise<void>;
+//# sourceMappingURL=key-user-translations.d.ts.map

package/dist/writer/i18n/key-user-translations.js

@@ -0,0 +1,109 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeLanguageForI18n = normalizeLanguageForI18n;
+exports.replaceTextsWithI18nBindings = replaceTextsWithI18nBindings;
+exports.writeKeyUserTranslations = writeKeyUserTranslations;
+const node_path_1 = require("node:path");
+const project_access_1 = require("@sap-ux/project-access");
+const i18n_1 = require("@sap-ux/i18n");
+/**
+ * Old-to-new ISO 639 language code mappings. Safety net for legacy systems that may still return deprecated codes.
+ * Source: sap/base/i18n/Localization.js M_ISO639_OLD_TO_NEW
+ */
+const M_ISO639_OLD_TO_NEW = {
+    'iw': 'he',
+    'ji': 'yi'
+};
+/**
+ * Normalizes a backend language key to the locale suffix used in i18n .properties file names.
+ *
+ * The backend (LRep) already normalizes language keys to ISO 639 via T002/T002X lookup,
+ * so this function primarily converts BCP47 separators (`-`) to underscores (`_`) for
+ * .properties file naming and applies old-to-new ISO 639 mapping as a safety net.
+ *
+ * @param lang - Language key from the backend response (e.g., '', 'en', 'iw', 'pt-BR', 'zh-Hans').
+ * @returns The normalized locale suffix for .properties file naming (e.g., '', 'en', 'he', 'pt_BR', 'zh_Hans').
+ */
+function normalizeLanguageForI18n(lang) {
+    if (!lang) {
+        return '';
+    }
+    // Parse BCP47 tag: language[-Script][-Region][-variant][-extension][-privateuse]
+    const parts = lang.split(/[-_]/);
+    let language = parts[0].toLowerCase();
+    // Apply old-to-new ISO 639 mapping as safety net
+    language = M_ISO639_OLD_TO_NEW[language] ?? language;
+    // Collect script and region subtags, skip variants/extensions/private use
+    const subtags = [];
+    for (const part of parts.slice(1)) {
+        if (/^[A-Za-z]{4}$/.test(part)) {
+            // Script subtag (e.g., Hans, Hant, Latn)
+            subtags.push(part[0].toUpperCase() + part.slice(1).toLowerCase());
+        }
+        else if (/^[A-Za-z]{2}$/.test(part)) {
+            // Region subtag (e.g., GB, TW, BR)
+            subtags.push(part.toUpperCase());
+        }
+    }
+    return subtags.length ? `${language}_${subtags.join('_')}` : language;
+}
+/**
+ * Replaces the `value` property of each entry in `content.texts` with an i18n binding expression.
+ * The generated key follows the pattern `<fileName>_<textId>`.
+ *
+ * @param contentTexts - The `texts` object from inside the change content.
+ * @param fileName - The file name of the change, used as key prefix.
+ * @returns The modified texts object with i18n bindings replacing values.
+ */
+function replaceTextsWithI18nBindings(contentTexts, fileName) {
+    const result = {};
+    for (const textId of Object.keys(contentTexts)) {
+        const entry = { ...contentTexts[textId] };
+        const generatedKey = `${fileName}_${textId}`;
+        entry.value = `{i18n>${generatedKey}}`;
+        result[textId] = entry;
+    }
+    return result;
+}
+/**
+ * Writes translations from the top-level `texts` object of a key-user change
+ * into the project's i18n .properties files.
+ *
+ * @param projectPath - The root path of the project.
+ * @param fileName - The file name of the change, used as key prefix.
+ * @param topLevelTexts - The top-level `texts` object from the API response entry.
+ * @param fs - The `mem-fs-editor` instance used for file operations.
+ */
+async function writeKeyUserTranslations(projectPath, fileName, topLevelTexts, fs) {
+    const webappPath = await (0, project_access_1.getWebappPath)(projectPath, fs);
+    const entriesByLanguage = {};
+    for (const textId of Object.keys(topLevelTexts)) {
+        const textEntry = topLevelTexts[textId];
+        const textType = textEntry.type;
+        const values = textEntry.values;
+        if (!values) {
+            continue;
+        }
+        const generatedKey = `${fileName}_${textId}`;
+        for (const lang of Object.keys(values)) {
+            const normalizedLang = normalizeLanguageForI18n(lang);
+            if (!entriesByLanguage[normalizedLang]) {
+                entriesByLanguage[normalizedLang] = [];
+            }
+            const entry = {
+                key: generatedKey,
+                value: values[lang]
+            };
+            if (textType) {
+                entry.annotation = { textType };
+            }
+            entriesByLanguage[normalizedLang].push(entry);
+        }
+    }
+    for (const lang of Object.keys(entriesByLanguage)) {
+        const propertiesFileName = lang ? `i18n_${lang}.properties` : 'i18n.properties';
+        const i18nFilePath = (0, node_path_1.join)(webappPath, 'i18n', propertiesFileName);
+        await (0, i18n_1.createPropertiesI18nEntries)(i18nFilePath, entriesByLanguage[lang], undefined, fs);
+    }
+}
+//# sourceMappingURL=key-user-translations.js.map

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.92",
+  "version": "0.18.94",
   "license": "Apache-2.0",
   "author": "@SAP/ux-tools-team",
   "main": "dist/index.js",
@@ -36,7 +36,7 @@
     "prompts": "2.4.2",
     "sanitize-filename": "1.6.3",
     "uuid": "11.1.0",
-    "@sap-ux/axios-extension": "1.25.23",
+    "@sap-ux/axios-extension": "1.25.24",
     "@sap-ux/btp-utils": "1.1.10",
     "@sap-ux/i18n": "0.3.9",
     "@sap-ux/inquirer-common": "0.11.24",
@@ -46,7 +46,7 @@
     "@sap-ux/project-access": "1.35.13",
     "@sap-ux/project-input-validator": "0.6.68",
     "@sap-ux/store": "1.5.10",
-    "@sap-ux/system-access": "0.6.65",
+    "@sap-ux/system-access": "0.6.66",
     "@sap-ux/ui5-config": "0.29.21",
     "@sap-ux/ui5-info": "0.13.15"
   },