@sap-ux/odata-service-writer 0.27.35 → 0.27.36

package/dist/update.js

@@ -63,49 +63,73 @@ function extendBackendMiddleware(fs, service, ui5Config, ui5ConfigPath, update =
     fs.write(ui5ConfigPath, ui5Config.toString());
 }
 /**
- * Adds services data to ui5-*.yaml files.
- * Mockserver configuration for services and annotations are written using dataSources from manifest.json.
- * At the end, XML files for service annotations are created.
+ * Updates UI5 YAML configurations with backend middleware.
  *
- * @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 {string} templateRoot - path to the file templates
- * @param {EdmxOdataService} service - the OData service instance
- * @param {Editor} fs - the memfs editor instance
+ * @param fs - the memfs editor instance
+ * @param service - the OData service instance
+ * @param paths - paths to the project files
+ * @returns Object containing ui5Config and ui5LocalConfig instances
  */
-async function addServicesData(basePath, paths, templateRoot, service, fs) {
+async function updateUI5YamlConfigs(fs, service, paths) {
     let ui5Config;
     let ui5LocalConfig;
-    let ui5MockConfig;
     if (paths.ui5Yaml) {
         ui5Config = await ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5Yaml));
-        // Update ui5.yaml with backend middleware
         extendBackendMiddleware(fs, service, ui5Config, paths.ui5Yaml);
-        // Update ui5-local.yaml with backend middleware
         if (paths.ui5LocalYaml) {
             ui5LocalConfig = await ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5LocalYaml));
             extendBackendMiddleware(fs, service, ui5LocalConfig, paths.ui5LocalYaml);
         }
     }
+    return { ui5Config, ui5LocalConfig };
+}
+/**
+ * Generates mockserver configuration and updates related YAML files.
+ *
+ * @param basePath - the root path of an existing UI5 application
+ * @param paths - paths to the project files
+ * @param service - the OData service instance
+ * @param webappPath - path to webapp folder
+ * @param ui5LocalConfig - ui5-local.yaml configuration
+ * @param fs - the memfs editor instance
+ */
+async function generateAndUpdateMockserverConfig(basePath, paths, service, webappPath, ui5LocalConfig, fs) {
+    const config = {
+        webappPath: webappPath,
+        ui5MockYamlConfig: {}
+    };
+    if (config.ui5MockYamlConfig && service.name && service.externalServices?.length) {
+        config.ui5MockYamlConfig.resolveExternalServiceReferences = {
+            [service.name]: true
+        };
+    }
+    await (0, mockserver_config_writer_1.generateMockserverConfig)(basePath, config, fs);
+    await generateMockserverMiddlewareBasedOnUi5MockYaml(fs, paths.ui5Yaml, paths.ui5LocalYaml, ui5LocalConfig);
+    if (paths.ui5MockYaml) {
+        const ui5MockConfig = await ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5MockYaml));
+        extendBackendMiddleware(fs, service, ui5MockConfig, paths.ui5MockYaml);
+    }
+}
+/**
+ * Adds services data to ui5-*.yaml files.
+ * Mockserver configuration for services and annotations are written using dataSources from manifest.json.
+ * At the end, XML files for service annotations are created.
+ *
+ * @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 {string} templateRoot - path to the file templates
+ * @param {EdmxOdataService} service - the OData service instance
+ * @param {Editor} fs - the memfs editor instance
+ */
+async function addServicesData(basePath, paths, templateRoot, service, fs) {
+    const { ui5Config, ui5LocalConfig } = await updateUI5YamlConfigs(fs, service, paths);
+    const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
     if (service.metadata) {
-        const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
         if (paths.ui5Yaml && ui5Config) {
-            const config = {
-                webappPath: webappPath
-            };
-            // Generate mockserver middleware for ui5-mock.yaml
-            await (0, mockserver_config_writer_1.generateMockserverConfig)(basePath, config, fs);
-            // Update ui5-local.yaml with mockserver middleware from newly created/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);
-            }
+            await generateAndUpdateMockserverConfig(basePath, paths, service, webappPath, ui5LocalConfig, fs);
         }
         await (0, annotations_1.writeLocalServiceAnnotationXMLFiles)(fs, webappPath, templateRoot, service);
     }
-    // Service is being added - update the package.json update as well, service update should not run the updates of the package.json
     if (paths.packageJson && paths.ui5Yaml) {
         (0, package_1.updatePackageJson)(paths.packageJson, fs, !!service.metadata);
     }
@@ -113,6 +137,9 @@ async function addServicesData(basePath, paths, templateRoot, service, fs) {
         fs.write(paths.ui5LocalYaml, ui5LocalConfig.toString());
     }
     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 services data in ui5-*.yaml files.

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.35",
+  "version": "0.27.36",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [