@sap-ux/odata-service-writer 1.0.17 → 1.0.18

package/dist/data/manifest.js

@@ -201,12 +201,28 @@ function removeUnusedAnnotations(fs, webappPath, dataSources, serviceName, creat
  * @param {string} webappPath - the webapp path of an existing UI5 application
  * @param dataSources - dataSources from manifest.json
  * @param serviceName - name of the OData service instance
- * @param {EdmxAnnotationsInfo | EdmxAnnotationsInfo[]} serviceRemoteAnnotations - remote annotations of the OData service instance
+ * @param {EdmxAnnotationsInfo | EdmxAnnotationsInfo[]} serviceRemoteAnnotations - remote annotations of the OData service instance; `undefined` preserves existing remote annotations (nothing pruned), an empty array prunes them
  * @param {boolean} cleanOldAnnotations - if true, checks and updates service annotations
  * @returns created annotation dataSources list for service.
  */
 function addRemoteAnnotationDataSources(fs, webappPath, dataSources, serviceName, serviceRemoteAnnotations, cleanOldAnnotations) {
     const createdAnnotations = [];
+    // `undefined` means the caller did not fetch annotations ("unknown"). Preserve the service's
+    // existing remote annotation references, dataSource entries and files - never treat unknown as
+    // "none". An explicit empty array is a caller-asserted "no annotations" and still prunes below.
+    if (serviceRemoteAnnotations === undefined) {
+        if (cleanOldAnnotations) {
+            const serviceAnnotations = dataSources?.[serviceName]?.settings?.annotations ?? [];
+            serviceAnnotations.forEach((name) => {
+                const dataSource = dataSources[name];
+                // Only re-collect remote annotations for the current service (uri differs from localUri).
+                if (dataSource?.type === 'ODataAnnotation' && dataSource.uri !== dataSource.settings?.localUri) {
+                    createdAnnotations.push(name);
+                }
+            });
+        }
+        return createdAnnotations;
+    }
     if (Array.isArray(serviceRemoteAnnotations)) {
         serviceRemoteAnnotations.forEach((remoteAnnotation) => {
             if (remoteAnnotation.name) {

package/dist/update.d.ts

@@ -20,7 +20,7 @@ export declare function addServicesData(basePath: string, paths: ProjectPaths, t
  * @param {ProjectPaths} paths - paths to the project files (package.json, ui5.yaml, ui5-local.yaml and ui5-mock.yaml)
  * @param {EdmxOdataService} service - the OData service instance
  * @param {Editor} fs - the memfs editor instance
- * @param {boolean} updateMiddlewares - whether the YAML files for the service (mock-server and fiori-tools-proxy middlewares) should be updated
+ * @param {boolean} updateMiddlewares - whether the backend proxy (fiori-tools-proxy) middleware in ui5*.yaml should be updated. The mockserver (sap-fe-mockserver) middleware is additionally regenerated whenever external (value-help) services are present, so the written external metadata stays resolvable.
  */
 export declare function updateServicesData(basePath: string, paths: ProjectPaths, service: EdmxOdataService, fs: Editor, updateMiddlewares: boolean): Promise<void>;
 //# sourceMappingURL=update.d.ts.map

package/dist/update.js

@@ -146,20 +146,27 @@ export async function addServicesData(basePath, paths, templateRoot, service, fs
  * @param {ProjectPaths} paths - paths to the project files (package.json, ui5.yaml, ui5-local.yaml and ui5-mock.yaml)
  * @param {EdmxOdataService} service - the OData service instance
  * @param {Editor} fs - the memfs editor instance
- * @param {boolean} updateMiddlewares - whether the YAML files for the service (mock-server and fiori-tools-proxy middlewares) should be updated
+ * @param {boolean} updateMiddlewares - whether the backend proxy (fiori-tools-proxy) middleware in ui5*.yaml should be updated. The mockserver (sap-fe-mockserver) middleware is additionally regenerated whenever external (value-help) services are present, so the written external metadata stays resolvable.
  */
 export async function updateServicesData(basePath, paths, service, fs, updateMiddlewares) {
     let ui5Config;
     let ui5LocalConfig;
-    if (updateMiddlewares) {
-        if (paths.ui5Yaml) {
-            ui5Config = await UI5Config.newInstance(fs.read(paths.ui5Yaml));
+    // The mockserver middleware is derived from the manifest and must stay consistent with the external
+    // (value-help) metadata files we write. Regenerate it whenever external services are present, even
+    // when the backend proxy middlewares are being preserved (updateMiddlewares === false).
+    const updateMockserver = updateMiddlewares || !!service.externalServices?.length;
+    if (updateMockserver && paths.ui5Yaml) {
+        ui5Config = await UI5Config.newInstance(fs.read(paths.ui5Yaml));
+        // Only re-point the backend proxy middleware when explicitly requested.
+        if (updateMiddlewares) {
             // Update ui5.yaml with backend middleware
             extendBackendMiddleware(fs, service, ui5Config, paths.ui5Yaml, true);
         }
+    }
+    if (updateMockserver && paths.ui5LocalYaml) {
+        ui5LocalConfig = await UI5Config.newInstance(fs.read(paths.ui5LocalYaml));
         // Update ui5-local.yaml with backend middleware
-        if (paths.ui5LocalYaml) {
-            ui5LocalConfig = await UI5Config.newInstance(fs.read(paths.ui5LocalYaml));
+        if (updateMiddlewares) {
             extendBackendMiddleware(fs, service, ui5LocalConfig, paths.ui5LocalYaml, true);
         }
     }
@@ -184,7 +191,7 @@ export async function updateServicesData(basePath, paths, service, fs, updateMid
  * @param {UI5Config | undefined} ui5Config - ui5.yaml configuration
  * @param {UI5Config | undefined} ui5LocalConfig - ui5-local.yaml configuration
  * @param {Editor} fs - the memfs editor instance
- * @param {boolean} updateMiddlewares - whether the YAML files for the service (mock-server and fiori-tools-proxy middlewares) should be updated
+ * @param {boolean} updateMiddlewares - whether the backend proxy (fiori-tools-proxy) middleware should be updated
  * @returns {Promise<string | undefined>} webapp path if metadata was written, undefined otherwise
  */
 async function updateMetadata(basePath, paths, service, ui5Config, ui5LocalConfig, fs, updateMiddlewares) {
@@ -192,8 +199,12 @@ async function updateMetadata(basePath, paths, service, ui5Config, ui5LocalConfi
         return undefined;
     }
     const webappPath = await getWebappPath(basePath, fs);
+    // The mockserver middleware is derived from the manifest and must stay consistent with the external
+    // (value-help) metadata files we write. Regenerate it whenever external services are present, even
+    // when the backend proxy middlewares are being preserved (updateMiddlewares === false).
+    const updateMockserver = updateMiddlewares || !!service.externalServices?.length;
     // Generate mockserver only when ui5-mock.yaml already exists
-    if (paths.ui5MockYaml && paths.ui5Yaml && ui5Config && updateMiddlewares) {
+    if (paths.ui5MockYaml && paths.ui5Yaml && ui5Config && updateMockserver) {
         const config = {
             webappPath: webappPath,
             // Since ui5-mock.yaml already exists, set 'skip' to skip package.json file updates
@@ -214,8 +225,9 @@ async function updateMetadata(basePath, paths, service, ui5Config, ui5LocalConfi
         await generateMockserverConfig(basePath, config, fs);
         // Update ui5-local.yaml with mockserver middleware from updated ui5-mock.yaml
         await generateMockserverMiddlewareBasedOnUi5MockYaml(fs, paths.ui5Yaml, paths.ui5LocalYaml, ui5LocalConfig);
-        // Update ui5-mock.yaml with backend middleware
-        if (paths.ui5MockYaml) {
+        // Update ui5-mock.yaml with backend middleware only when the backend proxy is being (re)pointed;
+        // a metadata re-sync (updateMiddlewares === false) preserves the existing proxy configuration.
+        if (updateMiddlewares && paths.ui5MockYaml) {
             const ui5MockConfig = await UI5Config.newInstance(fs.read(paths.ui5MockYaml));
             extendBackendMiddleware(fs, service, ui5MockConfig, paths.ui5MockYaml, true);
         }

package/package.json

@@ -10,7 +10,7 @@
   "bugs": {
     "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aodata-service-writer"
   },
-  "version": "1.0.17",
+  "version": "1.0.18",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [