@sap-ux/odata-service-writer 0.27.30 → 0.27.31

package/dist/data/external-services.d.ts

@@ -0,0 +1,29 @@
+import type { Editor } from 'mem-fs-editor';
+import type { ConvertedMetadata, RawSchema } from '@sap-ux/vocabularies-types';
+import type { ExternalService, ExternalServiceReference } from '@sap-ux/axios-extension';
+import type { ExternalServiceCollectionOptions } from '../types';
+/**
+ * Writes service metadata for external service references to the local service folder.
+ *
+ * @param fs - Memfs editor instance
+ * @param webappPath - Webapp path of the UI5 application
+ * @param externalServices - External service metadata to be written
+ * @param serviceName - Name of the service, defaults to 'mainService'
+ * @param servicePath - Service path of the service
+ */
+export declare function writeExternalServiceMetadata(fs: Editor, webappPath: string, externalServices: ExternalService[], serviceName?: string, servicePath?: string): void;
+/**
+ * Collects annotation values that reference external services from the given metadata and annotation files.
+ *
+ * @param serviceRootPath - The service path to which the value list references belong
+ * @param metadata - The metadata of the service
+ * @param annotations - The annotation files
+ * @param options - Options for collecting external service references.
+ * If not provided, all reference types are collected.
+ * To disable the collection of a specific type, set its value to `false`.
+ * @returns External service references found in the files.
+ */
+export declare function getExternalServiceReferences(serviceRootPath: string, metadata: ConvertedMetadata | RawSchema | string | undefined, annotations?: {
+    Definitions: string;
+}[], options?: Partial<ExternalServiceCollectionOptions>): ExternalServiceReference[];
+//# sourceMappingURL=external-services.d.ts.map

package/dist/data/external-services.js

@@ -0,0 +1,202 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.writeExternalServiceMetadata = writeExternalServiceMetadata;
+exports.getExternalServiceReferences = getExternalServiceReferences;
+const node_path_1 = require("node:path");
+const posix_1 = require("node:path/posix");
+const prettify_xml_1 = __importDefault(require("prettify-xml"));
+const annotation_converter_1 = require("@sap-ux/annotation-converter");
+const edmx_parser_1 = require("@sap-ux/edmx-parser");
+const project_access_1 = require("@sap-ux/project-access");
+const constants_1 = require("./constants");
+const INDENT_SIZE = 4;
+/**
+ * Writes service metadata for external service references to the local service folder.
+ *
+ * @param fs - Memfs editor instance
+ * @param webappPath - Webapp path of the UI5 application
+ * @param externalServices - External service metadata to be written
+ * @param serviceName - Name of the service, defaults to 'mainService'
+ * @param servicePath - Service path of the service
+ */
+function writeExternalServiceMetadata(fs, webappPath, externalServices, serviceName = constants_1.DEFAULT_DATASOURCE_NAME, servicePath) {
+    if (!externalServices.length || !servicePath) {
+        return;
+    }
+    const processedServices = new Set();
+    for (const reference of externalServices) {
+        const relativeServicePath = getServiceRoot(servicePath, reference.path);
+        const filePathSegments = [webappPath, project_access_1.DirName.LocalService, serviceName, relativeServicePath];
+        const servicePathWithoutParameters = reference.path.split(';')[0];
+        if (reference.entityData && !processedServices.has(servicePathWithoutParameters)) {
+            for (const entitySetData of reference.entityData) {
+                const entityDataPath = (0, node_path_1.join)(...filePathSegments, `${entitySetData.entitySetName}.json`);
+                fs.write(entityDataPath, JSON.stringify(entitySetData.items, undefined, INDENT_SIZE));
+            }
+            processedServices.add(servicePathWithoutParameters);
+        }
+        if (reference.type === 'value-list') {
+            filePathSegments.push(reference.target);
+        }
+        filePathSegments.push('metadata.xml');
+        const path = (0, node_path_1.join)(...filePathSegments);
+        if (reference.metadata) {
+            fs.write(path, (0, prettify_xml_1.default)(reference.metadata, { indent: INDENT_SIZE }));
+        }
+    }
+}
+/**
+ * Builds relative service root for file system.
+ *
+ * @param mainServicePath - Path of the main service from which the external service reference originates.
+ * @param pathWithParameters - Full path of the external service reference, possibly including parameters.
+ * @returns Relative service root path.
+ */
+function getServiceRoot(mainServicePath, pathWithParameters) {
+    const [servicePath] = pathWithParameters.split(';');
+    const segments = servicePath.split('/');
+    let prefix = '/';
+    let currentSegment = segments.shift();
+    while (currentSegment !== undefined) {
+        const next = (0, posix_1.join)(prefix, currentSegment);
+        if (!mainServicePath.startsWith(next)) {
+            break;
+        }
+        prefix = next;
+        currentSegment = segments.shift();
+    }
+    return servicePath.replace(prefix, '');
+}
+const DEFAULT_OPTIONS = {
+    valueListReferences: true,
+    codeLists: true
+};
+/**
+ * Fills missing parameters with defaults.
+ *
+ * @param options - Options for collecting external service references
+ * @returns External service collection options with all values set.
+ */
+function getOptions(options) {
+    if (!options) {
+        return {
+            ...DEFAULT_OPTIONS
+        };
+    }
+    return {
+        valueListReferences: options.valueListReferences ?? DEFAULT_OPTIONS.valueListReferences,
+        codeLists: options.codeLists ?? DEFAULT_OPTIONS.codeLists
+    };
+}
+/**
+ * Collects annotation values that reference external services from the given metadata and annotation files.
+ *
+ * @param serviceRootPath - The service path to which the value list references belong
+ * @param metadata - The metadata of the service
+ * @param annotations - The annotation files
+ * @param options - Options for collecting external service references.
+ * If not provided, all reference types are collected.
+ * To disable the collection of a specific type, set its value to `false`.
+ * @returns External service references found in the files.
+ */
+function getExternalServiceReferences(serviceRootPath, metadata, annotations = [], options) {
+    const finalOptions = getOptions(options);
+    if (!metadata) {
+        return [];
+    }
+    const files = [metadata, ...annotations.map((annotationFile) => annotationFile.Definitions)];
+    const references = [];
+    for (const data of files) {
+        const schema = typeof data === 'string' ? (0, annotation_converter_1.convert)((0, edmx_parser_1.parse)(data)) : data;
+        for (const annotationLists of Object.values(schema.annotations)) {
+            for (const annotationList of annotationLists) {
+                const target = annotationList.target.replace(schema.namespace + '.', '');
+                collectExternalServiceReferences(finalOptions, references, target, annotationList, serviceRootPath);
+            }
+        }
+    }
+    return references;
+}
+/**
+ * Collects ValueListReference values from targets annotations.
+ *
+ * @param options - Options for collecting external service references
+ * @param references - The collected value list references
+ * @param target - The target of the annotation list
+ * @param annotationList - The annotation list to be checked
+ * @param serviceRootPath - The service path to which the value list references belong
+ */
+function collectExternalServiceReferences(options, references, target, annotationList, serviceRootPath) {
+    for (const annotation of annotationList.annotations) {
+        collectValueListReferences(options, references, target, annotation, serviceRootPath);
+        collectCodeLists(options, references, annotation, serviceRootPath);
+    }
+}
+/**
+ * Collects ValueListReferences annotations.
+ *
+ * @param options - Options for collecting external service references
+ * @param references - The collected value list references
+ * @param target - The target of the annotation list
+ * @param annotation - The annotation to be checked
+ * @param serviceRootPath - The service path to which the value list references belong
+ */
+function collectValueListReferences(options, references, target, annotation, serviceRootPath) {
+    if (options.valueListReferences && annotation.term === 'com.sap.vocabularies.Common.v1.ValueListReferences') {
+        for (const value of annotation.collection ?? []) {
+            if (value.type === 'String') {
+                const stringValue = value;
+                references.push({
+                    type: 'value-list',
+                    serviceRootPath,
+                    target,
+                    value: stringValue.String
+                });
+            }
+        }
+    }
+}
+/**
+ * Collects CodeList annotations.
+ *
+ * @param options - Options for collecting external service references
+ * @param references - The collected value list references
+ * @param annotation - The annotation to be checked
+ * @param serviceRootPath - The service path to which the value list references belong
+ */
+function collectCodeLists(options, references, annotation, serviceRootPath) {
+    if (options.codeLists &&
+        (annotation.term === 'com.sap.vocabularies.CodeList.v1.CurrencyCodes' ||
+            annotation.term === 'com.sap.vocabularies.CodeList.v1.UnitsOfMeasure') &&
+        annotation.record) {
+        const collectionPath = getPropertyValue(annotation.record, 'CollectionPath');
+        const url = getPropertyValue(annotation.record, 'Url');
+        if (url) {
+            references.push({
+                type: 'code-list',
+                serviceRootPath,
+                value: url,
+                collectionPath: collectionPath ?? undefined
+            });
+        }
+    }
+}
+/**
+ * Reads property value from annotation record.
+ *
+ * @param record - Annotation record
+ * @param propertyName - Name of the property
+ * @returns Value of the property if it exists
+ */
+function getPropertyValue(record, propertyName) {
+    const property = record.propertyValues.find((prop) => prop.name === propertyName);
+    if (property?.value?.type === 'String') {
+        const value = property.value;
+        return value.String;
+    }
+    return undefined;
+}
+//# sourceMappingURL=external-services.js.map

package/dist/data/index.d.ts

@@ -1,3 +1,4 @@
 export * from './defaults';
 export * from './annotations';
+export * from './external-services';
 //# sourceMappingURL=index.d.ts.map

package/dist/data/index.js

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

package/dist/index.d.ts

@@ -1,6 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import { getAnnotationNamespaces } from './data';
-import { OdataService, OdataVersion, ServiceType, CdsAnnotationsInfo, EdmxAnnotationsInfo, NamespaceAlias } from './types';
+import type { OdataService } from './types';
 /**
  * Writes the odata service related data and files to an existing UI5 project specified by the base path.
  *
@@ -10,7 +9,7 @@ import { OdataService, OdataVersion, ServiceType, CdsAnnotationsInfo, EdmxAnnota
  * @throws {Error} - if required UI5 project files are not found
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-declare function generate(basePath: string, service: OdataService, fs?: Editor): Promise<Editor>;
+export declare function generate(basePath: string, service: OdataService, fs?: Editor): Promise<Editor>;
 /**
  * Writes the odata service related file updates to an existing UI5 project specified by the base path.
  *
@@ -21,7 +20,7 @@ declare function generate(basePath: string, service: OdataService, fs?: Editor):
  * @throws {Error} - if required UI5 project files are not found
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-declare function update(basePath: string, service: OdataService, fs?: Editor, updateMiddlewares?: boolean): Promise<Editor>;
+export declare function update(basePath: string, service: OdataService, fs?: Editor, updateMiddlewares?: boolean): Promise<Editor>;
 /**
  * Removes service related data from project files for an existing UI5 project specified by the base path.
  * How the method works:
@@ -48,7 +47,7 @@ declare function update(basePath: string, service: OdataService, fs?: Editor, up
  * @throws {Error} - if required UI5 project files are not found
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-declare function remove(basePath: string, service: OdataService, fs?: Editor): Promise<Editor>;
-export { generate, update, remove, OdataVersion, OdataService, ServiceType, EdmxAnnotationsInfo, CdsAnnotationsInfo };
-export { getAnnotationNamespaces, NamespaceAlias };
+export declare function remove(basePath: string, service: OdataService, fs?: Editor): Promise<Editor>;
+export { OdataVersion, OdataService, ServiceType, EdmxAnnotationsInfo, CdsAnnotationsInfo, ExternalServiceCollectionOptions, NamespaceAlias } from './types';
+export { getExternalServiceReferences, getAnnotationNamespaces, writeExternalServiceMetadata } from './data';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getAnnotationNamespaces = exports.ServiceType = exports.OdataVersion = void 0;
+exports.writeExternalServiceMetadata = exports.getAnnotationNamespaces = exports.getExternalServiceReferences = exports.ServiceType = exports.OdataVersion = void 0;
 exports.generate = generate;
 exports.update = update;
 exports.remove = remove;
@@ -9,11 +9,8 @@ const mem_fs_1 = require("mem-fs");
 const mem_fs_editor_1 = require("mem-fs-editor");
 const update_1 = require("./update");
 const data_1 = require("./data");
-Object.defineProperty(exports, "getAnnotationNamespaces", { enumerable: true, get: function () { return data_1.getAnnotationNamespaces; } });
 const i18n_1 = require("./i18n");
 const types_1 = require("./types");
-Object.defineProperty(exports, "OdataVersion", { enumerable: true, get: function () { return types_1.OdataVersion; } });
-Object.defineProperty(exports, "ServiceType", { enumerable: true, get: function () { return types_1.ServiceType; } });
 const delete_1 = require("./delete");
 const project_access_1 = require("@sap-ux/project-access");
 const manifest_1 = require("./data/manifest");
@@ -160,4 +157,11 @@ async function remove(basePath, service, fs) {
     }
     return fs;
 }
+var types_2 = require("./types");
+Object.defineProperty(exports, "OdataVersion", { enumerable: true, get: function () { return types_2.OdataVersion; } });
+Object.defineProperty(exports, "ServiceType", { enumerable: true, get: function () { return types_2.ServiceType; } });
+var data_2 = require("./data");
+Object.defineProperty(exports, "getExternalServiceReferences", { enumerable: true, get: function () { return data_2.getExternalServiceReferences; } });
+Object.defineProperty(exports, "getAnnotationNamespaces", { enumerable: true, get: function () { return data_2.getAnnotationNamespaces; } });
+Object.defineProperty(exports, "writeExternalServiceMetadata", { enumerable: true, get: function () { return data_2.writeExternalServiceMetadata; } });
 //# sourceMappingURL=index.js.map

package/dist/types.d.ts

@@ -1,5 +1,10 @@
 import type { ManifestNamespace } from '@sap-ux/project-access';
 import type { FioriToolsProxyConfigBackend as ProxyBackend } from '@sap-ux/ui5-config';
+import type { ExternalService } from '@sap-ux/axios-extension';
+export interface ExternalServiceCollectionOptions {
+    valueListReferences: boolean;
+    codeLists: boolean;
+}
 export declare enum OdataVersion {
     v2 = "2",
     v4 = "4"
@@ -63,6 +68,7 @@ export interface OdataService {
     name?: string;
     model?: string;
     metadata?: string;
+    externalServices?: ExternalService[];
     /**
      * Annotations can either be EDMX annotations or CDS annotations.
      */

package/dist/update.js

@@ -8,6 +8,7 @@ const ui5_config_1 = require("@sap-ux/ui5-config");
 const mockserver_config_writer_1 = require("@sap-ux/mockserver-config-writer");
 const annotations_1 = require("./data/annotations");
 const package_1 = require("./data/package");
+const data_1 = require("./data");
 /**
  * Generates mockserver middleware config for ui5-local.yaml file based on ui5-mock.yaml.
  *
@@ -126,7 +127,6 @@ async function addServicesData(basePath, paths, templateRoot, service, fs) {
 async function updateServicesData(basePath, paths, service, fs, updateMiddlewares) {
     let ui5Config;
     let ui5LocalConfig;
-    let ui5MockConfig;
     if (updateMiddlewares) {
         if (paths.ui5Yaml) {
             ui5Config = await ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5Yaml));
@@ -140,39 +140,64 @@ async function updateServicesData(basePath, paths, service, fs, updateMiddleware
         }
     }
     // For update, updatable files should already exist
-    if (service.metadata) {
-        const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
-        // Generate mockserver only when ui5-mock.yaml already exists
-        if (paths.ui5MockYaml && paths.ui5Yaml && ui5Config && updateMiddlewares) {
-            const config = {
-                webappPath: webappPath,
-                // Since ui5-mock.yaml already exists, set 'skip' to skip package.json file updates
-                packageJsonConfig: {
-                    skip: true
-                },
-                // Set 'overwrite' to true to overwrite services data in YAML files
-                ui5MockYamlConfig: {
-                    overwrite: true
-                }
-            };
-            // Regenerate mockserver middleware for ui5-mock.yaml by overwriting
-            await (0, mockserver_config_writer_1.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) {
-                ui5MockConfig = await ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5MockYaml));
-                extendBackendMiddleware(fs, service, ui5MockConfig, paths.ui5MockYaml, true);
-            }
-        }
-        // Write metadata.xml file
-        await (0, annotations_1.writeMetadata)(fs, webappPath, service);
-    }
+    const webappPath = await updateMetadata(basePath, paths, service, ui5Config, ui5LocalConfig, fs, updateMiddlewares);
     if (paths.ui5LocalYaml && ui5LocalConfig) {
         // write ui5 local yaml if service type is not CDS
         fs.write(paths.ui5LocalYaml, ui5LocalConfig.toString());
     }
     // Write new annotations files
     await (0, annotations_1.writeRemoteServiceAnnotationXmlFiles)(fs, basePath, service.name ?? 'mainService', service.annotations);
+    if (service.externalServices && webappPath) {
+        (0, data_1.writeExternalServiceMetadata)(fs, webappPath, service.externalServices, service.name, service.path);
+    }
+}
+/**
+ * Updates metadata related data for the given service in the project files.
+ *
+ * @param {string} basePath - the root path of an existing UI5 application
+ * @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 {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
+ * @returns {Promise<string | undefined>} webapp path if metadata was written, undefined otherwise
+ */
+async function updateMetadata(basePath, paths, service, ui5Config, ui5LocalConfig, fs, updateMiddlewares) {
+    if (!service.metadata) {
+        return undefined;
+    }
+    const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
+    // Generate mockserver only when ui5-mock.yaml already exists
+    if (paths.ui5MockYaml && paths.ui5Yaml && ui5Config && updateMiddlewares) {
+        const config = {
+            webappPath: webappPath,
+            // Since ui5-mock.yaml already exists, set 'skip' to skip package.json file updates
+            packageJsonConfig: {
+                skip: true
+            },
+            // Set 'overwrite' to true to overwrite services data in YAML files
+            ui5MockYamlConfig: {
+                overwrite: true
+            }
+        };
+        if (config.ui5MockYamlConfig && service.name && service.externalServices?.length) {
+            config.ui5MockYamlConfig.resolveExternalServiceReferences = {
+                [service.name]: true
+            };
+        }
+        // Regenerate mockserver middleware for ui5-mock.yaml by overwriting
+        await (0, mockserver_config_writer_1.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) {
+            const ui5MockConfig = await ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5MockYaml));
+            extendBackendMiddleware(fs, service, ui5MockConfig, paths.ui5MockYaml, true);
+        }
+    }
+    // Write metadata.xml file
+    await (0, annotations_1.writeMetadata)(fs, webappPath, service);
+    return webappPath;
 }
 //# sourceMappingURL=update.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%3Aodata-service-writer"
   },
-  "version": "0.27.30",
+  "version": "0.27.31",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -20,6 +20,8 @@
     "!dist/**/*.map"
   ],
   "dependencies": {
+    "@sap-ux/edmx-parser": "0.9.1",
+    "@sap-ux/annotation-converter": "0.10.8",
     "ejs": "3.1.10",
     "fast-xml-parser": "4.4.1",
     "i18next": "25.3.0",
@@ -27,18 +29,20 @@
     "mem-fs-editor": "9.4.0",
     "prettify-xml": "1.2.0",
     "semver": "7.5.4",
-    "@sap-ux/mockserver-config-writer": "0.9.26",
-    "@sap-ux/project-access": "1.32.9",
-    "@sap-ux/ui5-config": "0.29.9"
+    "@sap-ux/mockserver-config-writer": "0.9.27",
+    "@sap-ux/project-access": "1.32.10",
+    "@sap-ux/ui5-config": "0.29.10"
   },
   "devDependencies": {
+    "@sap-ux/vocabularies-types": "0.13.1",
     "@types/ejs": "3.1.2",
     "@types/fs-extra": "9.0.13",
     "@types/mem-fs": "1.1.2",
     "@types/mem-fs-editor": "7.0.1",
     "@types/semver": "7.5.2",
     "fs-extra": "10.0.0",
-    "lodash": "4.17.21"
+    "lodash": "4.17.21",
+    "@sap-ux/axios-extension": "1.24.3"
   },
   "engines": {
     "node": ">=20.x"