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

package/dist/data/defaults.d.ts

@@ -7,7 +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
+ * @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, 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,14 +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
+ * @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, update = false) {
     if (!update) {
         setDefaultServicePath(service);
     }
-    await setDefaultServiceName(basePath, service, fs);
-    await setDefaultServiceModel(basePath, service, fs);
+    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/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/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.1",
+  "version": "0.27.2",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [