@sap-ux/odata-service-writer 0.27.0 → 0.27.2

package/dist/data/defaults.d.ts

@@ -7,6 +7,7 @@ import type { Editor } from 'mem-fs-editor';
  * @param {string} basePath - the root path of an existing UI5 application
  * @param {OdataService} service - the OData service instance
  * @param {Editor} fs - the memfs editor instance
+ * @param {boolean} update - whether the service update is running (if true, skips unique service name generation and makes sure that '' model is updated for the mainService)
  */
-export declare function enhanceData(basePath: string, service: OdataService, fs: Editor): Promise<void>;
+export declare function enhanceData(basePath: string, service: OdataService, fs: Editor, update?: boolean): Promise<void>;
 //# sourceMappingURL=defaults.d.ts.map

package/dist/data/defaults.js

@@ -16,15 +16,37 @@ const ui5_config_1 = require("@sap-ux/ui5-config");
 function setDefaultServicePath(service) {
     service.path = service.path?.endsWith('/') ? service.path : (service.path ?? '') + '/';
 }
+/**
+ * Generates a unique name for the service.
+ *
+ * @param {OdataService} dataSources - dataSources from manifest.json.
+ * @param {string} serviceName - The service name whose name needs to be modified.
+ * @returns Unique service name.
+ */
+function generateUniqueServiceName(dataSources, serviceName) {
+    let tmpSrvName = serviceName;
+    let uniqueNameCount = 1;
+    let doesExist = true; // Ensure data source name is unique
+    do {
+        if (dataSources?.[tmpSrvName]) {
+            tmpSrvName = `${serviceName}${uniqueNameCount++}`; // Try with a new name
+        }
+        else {
+            doesExist = false;
+        }
+    } while (doesExist);
+    return tmpSrvName;
+}
 /**
  * Sets the default name for a given service.
  * Default serivce name is used only for first service.
  *
  * @param {string} basePath - the root path of an existing UI5 application
  * @param {OdataService} service - The service object whose name needs to be set or modified.
- * @param fs - the memfs editor instance
+ * @param {Editor} fs - the memfs editor instance
+ * @param {boolean} update - whether the service update is running
  */
-async function setDefaultServiceName(basePath, service, fs) {
+async function setDefaultServiceName(basePath, service, fs, update) {
     const manifestPath = (0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath, fs), project_access_1.FileName.Manifest);
     const manifest = fs.readJSON(manifestPath);
     // Check if manifest has already any dataSources defined, DEFAULT_DATASOURCE_NAME should be used for the first service
@@ -35,6 +57,9 @@ async function setDefaultServiceName(basePath, service, fs) {
         if (oDataSources.length === 0) {
             service.name = constants_1.DEFAULT_DATASOURCE_NAME;
         }
+        else if (service.name && !update) {
+            service.name = generateUniqueServiceName(dataSources, service.name);
+        }
     }
     else {
         // No existing dataSources - no existing services, use default name
@@ -48,9 +73,10 @@ async function setDefaultServiceName(basePath, service, fs) {
  *
  * @param {string} basePath - the root path of an existing UI5 application
  * @param {OdataService} service - The service object whose model needs to be set or modified
- * @param fs - the memfs editor instance
+ * @param {Editor} fs - the memfs editor instance
+ * @param {boolean} update - whether the service update is running (if true, makes sure that '' model is updated for the mainService)
  */
-async function setDefaultServiceModel(basePath, service, fs) {
+async function setDefaultServiceModel(basePath, service, fs, update) {
     const manifestPath = (0, path_1.join)(await (0, project_access_1.getWebappPath)(basePath, fs), 'manifest.json');
     const manifest = fs.readJSON(manifestPath);
     if (!service.model) {
@@ -59,12 +85,15 @@ async function setDefaultServiceModel(basePath, service, fs) {
         if (models) {
             // Filter dataSource models by dataSource property
             const servicesModels = Object.values(models).filter((model) => model.dataSource);
-            service.model =
-                servicesModels.length === 0 ||
-                    (servicesModels.find((serviceModel) => serviceModel.dataSource === constants_1.DEFAULT_DATASOURCE_NAME) &&
-                        service.name === constants_1.DEFAULT_DATASOURCE_NAME) // model for mainService is ""
-                    ? ''
-                    : service.name;
+            if (servicesModels.length === 0 ||
+                (update &&
+                    servicesModels.find((serviceModel) => serviceModel.dataSource === constants_1.DEFAULT_DATASOURCE_NAME) &&
+                    service.name === constants_1.DEFAULT_DATASOURCE_NAME)) {
+                service.model = '';
+            }
+            else if (service.name) {
+                service.model = service.name;
+            }
         }
         else {
             // No models defined, that means first one is being added, set model to ''
@@ -147,11 +176,14 @@ async function setDefaultPreviewSettings(basePath, service, fs) {
  * @param {string} basePath - the root path of an existing UI5 application
  * @param {OdataService} service - the OData service instance
  * @param {Editor} fs - the memfs editor instance
+ * @param {boolean} update - whether the service update is running (if true, skips unique service name generation and makes sure that '' model is updated for the mainService)
  */
-async function enhanceData(basePath, service, fs) {
-    setDefaultServicePath(service);
-    await setDefaultServiceName(basePath, service, fs);
-    await setDefaultServiceModel(basePath, service, fs);
+async function enhanceData(basePath, service, fs, update = false) {
+    if (!update) {
+        setDefaultServicePath(service);
+    }
+    await setDefaultServiceName(basePath, service, fs, update);
+    await setDefaultServiceModel(basePath, service, fs, update);
     // set service type to EDMX if not defined
     service.type = service.type ?? types_1.ServiceType.EDMX;
     /**

package/dist/data/manifest.js

@@ -403,17 +403,26 @@ async function updateManifest(basePath, service, fs, forceServiceUpdate = false)
     const manifest = fs.readJSON(manifestPath);
     const appProp = 'sap.app';
     const appid = manifest?.[appProp]?.id;
+    const dataSources = manifest[appProp]?.dataSources ?? {};
     // Throw if required property is not found manifest.json
     if (!appid) {
         throw new Error((0, i18n_1.t)('error.requiredProjectPropertyNotFound', { property: `'${appProp}'.id`, path: manifestPath }));
     }
     // Throw if only update is required and service is not found in manifest.json
-    if (forceServiceUpdate && service.name && !manifest[appProp]?.dataSources?.[service.name]) {
+    if (forceServiceUpdate && service.name && !dataSources?.[service.name]) {
         throw new Error((0, i18n_1.t)('error.requiredProjectPropertyNotFound', {
             property: `'${appProp}.dataSources.${service.name}'`,
             path: manifestPath
         }));
     }
+    // Throw if service is being added, but service with the same URI already exists
+    if (!forceServiceUpdate &&
+        service.path &&
+        Object.values(dataSources).find((dataSource) => dataSource.uri === service.path)) {
+        throw new Error((0, i18n_1.t)('error.requiredServiceAlreadyExists', {
+            uri: service.path
+        }));
+    }
     // Check and update existing services in a way that is supported by multiple services
     const convertedManifest = await addMultipleServiceSupportToManifest(webappPath, manifest, fs);
     // Update manifest.json services

package/dist/index.d.ts

@@ -17,10 +17,11 @@ declare function generate(basePath: string, service: OdataService, fs?: Editor):
  * @param {string} basePath - the root path of an existing UI5 application
  * @param {OdataService} 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
  * @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): Promise<Editor>;
+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:

package/dist/index.js

@@ -97,22 +97,23 @@ async function generate(basePath, service, fs) {
  * @param {string} basePath - the root path of an existing UI5 application
  * @param {OdataService} 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
  * @throws {Error} - if required UI5 project files are not found
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
-async function update(basePath, service, fs) {
+async function update(basePath, service, fs, updateMiddlewares = true) {
     if (!fs) {
         fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
     }
     const paths = await findProjectFiles(basePath, fs);
     const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
     ensureExists(webappPath, ['manifest.json'], fs);
-    await (0, data_1.enhanceData)(basePath, service, fs);
+    await (0, data_1.enhanceData)(basePath, service, fs, true);
     // Set isServiceTypeEdmx true if service is EDMX
     const isServiceTypeEdmx = service.type === types_1.ServiceType.EDMX;
     await (0, manifest_1.updateManifest)(basePath, service, fs, true);
     // Dont extend/update backend and mockserver middlewares if service type is CDS
-    if (isServiceTypeEdmx) {
+    if (isServiceTypeEdmx && updateMiddlewares) {
         await (0, update_1.updateServicesData)(basePath, paths, service, fs);
     }
     return fs;

package/dist/translations/odata-service-writer.i18n.json

@@ -2,6 +2,7 @@
     "error": {
         "requiredProjectFileNotFound": "Invalid project structure. Cannot find required file {{-path}}",
         "requiredProjectPropertyNotFound": "Required project property: {{-property}} was not found in file: {{-path}}",
+        "requiredServiceAlreadyExists": "A service with the {{-uri}} URI already exists. Choose another service.",
         "unparseableXML": "Unparseable XML was specified: {{-error}}"
     }
 }

package/dist/types.d.ts

@@ -1,3 +1,4 @@
+import type { ManifestNamespace } from '@sap-ux/project-access';
 import type { FioriToolsProxyConfigBackend as ProxyBackend } from '@sap-ux/ui5-config';
 export declare enum OdataVersion {
     v2 = "2",
@@ -82,4 +83,7 @@ export interface ProjectPaths {
     ui5LocalYaml?: string;
     ui5MockYaml?: string;
 }
+export type DataSources = {
+    [k: string]: ManifestNamespace.DataSource;
+};
 //# sourceMappingURL=types.d.ts.map

package/dist/update.d.ts

@@ -15,7 +15,6 @@ export declare function addServicesData(basePath: string, paths: ProjectPaths, t
 /**
  * Updates services data in ui5-*.yaml files.
  * Mockserver configuration for services and annotations are updated using dataSources from manifest.json.
- * At the end, older XML files for service annotations are removed and new annotations are generated.
  *
  * @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)

package/dist/update.js

@@ -27,28 +27,36 @@ async function generateMockserverMiddlewareBasedOnUi5MockYaml(fs, ui5YamlPath, u
     }
 }
 /**
- * Extends backend middleware for UI5Config with service data.
+ * Extends backend middleware for UI5Config with the service data.
  *
  * @param {Editor} fs - the memfs editor instance
  * @param {OdataService} service - the OData service instance data
  * @param {UI5Config} ui5Config - UI5 configuration
  * @param {string} ui5ConfigPath - path to the YAML config file
+ * @param {boolean} update - whether the service update is running
  * @throws {Error} - if required UI5 project files are not found
  */
-function extendBackendMiddleware(fs, service, ui5Config, ui5ConfigPath) {
-    try {
-        ui5Config.addBackendToFioriToolsProxydMiddleware(service.previewSettings, service.ignoreCertError);
+function extendBackendMiddleware(fs, service, ui5Config, ui5ConfigPath, update = false) {
+    if (update) {
+        ui5Config.updateBackendToFioriToolsProxydMiddleware(service.previewSettings);
     }
-    catch (error) {
-        if ((error instanceof ui5_config_1.YAMLError && error.code === ui5_config_1.yamlErrorCode.nodeNotFound) ||
-            error.message === 'Could not find fiori-tools-proxy') {
-            ui5Config.addFioriToolsProxydMiddleware({
-                backend: [service.previewSettings],
-                ignoreCertError: service.ignoreCertError
-            });
+    else {
+        // Try to add backend
+        try {
+            ui5Config.addBackendToFioriToolsProxydMiddleware(service.previewSettings, service.ignoreCertError);
         }
-        else {
-            throw error;
+        catch (error) {
+            if ((error instanceof ui5_config_1.YAMLError && error.code === ui5_config_1.yamlErrorCode.nodeNotFound) ||
+                error.message === 'Could not find fiori-tools-proxy') {
+                // Middleware is missing, add it along with the service backend
+                ui5Config.addFioriToolsProxydMiddleware({
+                    backend: [service.previewSettings],
+                    ignoreCertError: service.ignoreCertError
+                });
+            }
+            else {
+                throw error;
+            }
         }
     }
     fs.write(ui5ConfigPath, ui5Config.toString());
@@ -108,7 +116,6 @@ async function addServicesData(basePath, paths, templateRoot, service, fs) {
 /**
  * Updates services data in ui5-*.yaml files.
  * Mockserver configuration for services and annotations are updated using dataSources from manifest.json.
- * At the end, older XML files for service annotations are removed and new annotations are generated.
  *
  * @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)
@@ -118,37 +125,45 @@ async function addServicesData(basePath, paths, templateRoot, service, fs) {
 async function updateServicesData(basePath, paths, service, fs) {
     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, true);
     }
+    // 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, true);
     }
     // 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) {
-            if (paths.ui5Yaml && ui5Config) {
-                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);
-                if (paths.ui5LocalYaml && ui5LocalConfig) {
-                    // write ui5 local yaml if service type is not CDS
-                    fs.write(paths.ui5LocalYaml, ui5LocalConfig.toString());
+        if (paths.ui5MockYaml && paths.ui5Yaml && ui5Config) {
+            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);
+            }
+            if (paths.ui5LocalYaml && ui5LocalConfig) {
+                // write ui5 local yaml if service type is not CDS
+                fs.write(paths.ui5LocalYaml, ui5LocalConfig.toString());
             }
         }
         // Write metadata.xml file

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.0",
+  "version": "0.27.2",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -27,9 +27,9 @@
     "mem-fs-editor": "9.4.0",
     "prettify-xml": "1.2.0",
     "semver": "7.5.4",
-    "@sap-ux/mockserver-config-writer": "0.9.0",
-    "@sap-ux/project-access": "1.30.0",
-    "@sap-ux/ui5-config": "0.28.0"
+    "@sap-ux/mockserver-config-writer": "0.9.1",
+    "@sap-ux/project-access": "1.30.1",
+    "@sap-ux/ui5-config": "0.28.1"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",