@sap-ux/odata-service-writer 0.24.0 → 0.24.2

package/dist/index.js

@@ -219,7 +219,7 @@ async function generate(basePath, service, fs) {
     // Prepare template folder for manifest and xml updates
     const templateRoot = (0, path_1.join)(__dirname, '../templates');
     // Update manifest.json
-    (0, updates_1.updateManifest)(basePath, service, fs, templateRoot);
+    await (0, updates_1.updateManifest)(basePath, service, fs, templateRoot);
     // Dont extend backend and mockserver middlewares if service type is CDS
     if (isServiceTypeEdmx) {
         await writeEDMXServiceFiles(fs, basePath, paths, templateRoot, service);

package/dist/types.d.ts

@@ -66,7 +66,7 @@ export interface OdataService {
      * Annotations can either be EDMX annotations or CDS annotations.
      */
     annotations?: EdmxAnnotationsInfo | EdmxAnnotationsInfo[] | CdsAnnotationsInfo | CdsAnnotationsInfo[];
-    localAnnotationsName?: string;
+    localAnnotationsName?: string | string[];
     previewSettings?: Partial<ProxyBackend>;
     /**
      * Indicates whether certificate errors should be ignored.

package/dist/updates.d.ts

@@ -8,7 +8,7 @@ import type { OdataService, CdsAnnotationsInfo, EdmxAnnotationsInfo } from './ty
  * @param fs - the memfs editor instance
  * @param templateRoot - root folder contain the ejs templates
  */
-export declare function updateManifest(basePath: string, service: OdataService, fs: Editor, templateRoot: string): void;
+export declare function updateManifest(basePath: string, service: OdataService, fs: Editor, templateRoot: string): Promise<void>;
 /**
  * Writes annotation XML files for EDMX service annotations.
  *

package/dist/updates.js

@@ -13,6 +13,58 @@ const i18n_1 = require("./i18n");
 const semver_1 = __importDefault(require("semver"));
 const prettify_xml_1 = __importDefault(require("prettify-xml"));
 const project_access_1 = require("@sap-ux/project-access");
+/**
+ * Modifies service in manifest.json and service files in a way that is supported by multiple services.
+ * If service files are defined in 'localService' folder then those files are moved to respective service folder and service configuration URI are modified in manifest.json.
+ *
+ * @param {string} webappPath - the webapp path of an existing UI5 application
+ * @param {string} dataSourceKey - dataSource key in manifest.json
+ * @param {Manifest} dataSource - dataSource configuration from manifest.json
+ * @param {Editor} fs - the memfs editor instance
+ */
+function updateExistingService(webappPath, dataSourceKey, dataSource, fs) {
+    const settings = dataSource.settings;
+    if (settings) {
+        // "localService/metadata.xml"
+        const localUri = settings.localUri;
+        // -> ["localService", "metadata.xml"]
+        const localUriParts = localUri ? localUri.split('/') : undefined;
+        if (localUriParts && localUriParts[0] === project_access_1.DirName.LocalService && localUriParts.length === 2) {
+            const localFileName = localUriParts[localUriParts.length - 1];
+            settings.localUri = `${project_access_1.DirName.LocalService}/${dataSourceKey}/${localFileName}`;
+            // move related files to service folder
+            const fromFilePath = (0, path_1.join)(webappPath, localUriParts.join(path_1.sep));
+            const toFilePath = (0, path_1.join)(webappPath, project_access_1.DirName.LocalService, dataSourceKey, localFileName);
+            if (fs.exists(fromFilePath)) {
+                fs.move(fromFilePath, toFilePath);
+            }
+        }
+    }
+}
+/**
+ * Modifies services in manifest.json and services files in a way that is supported by multiple services.
+ *
+ * @param {string} webappPath - the webapp path of an existing UI5 application
+ * @param {Manifest} manifest - the manifest.json of the application
+ * @param {Editor} fs - the memfs editor instance
+ */
+async function updateExistingServices(webappPath, manifest, fs) {
+    const dataSources = manifest?.['sap.app']?.dataSources;
+    for (const dataSourceKey in dataSources) {
+        const dataSource = dataSources[dataSourceKey];
+        if (dataSource.type === 'OData') {
+            updateExistingService(webappPath, dataSourceKey, dataSource, fs);
+            const annotations = dataSource.settings?.annotations;
+            if (annotations) {
+                annotations.forEach((annotationName) => {
+                    const annotationDataSource = dataSources[annotationName];
+                    updateExistingService(webappPath, dataSourceKey, annotationDataSource, fs);
+                });
+            }
+        }
+    }
+    fs.writeJSON((0, path_1.join)(webappPath, 'manifest.json'), manifest);
+}
 /**
  * Internal function that updates the manifest.json based on the given service configuration.
  *
@@ -21,18 +73,22 @@ const project_access_1 = require("@sap-ux/project-access");
  * @param fs - the memfs editor instance
  * @param templateRoot - root folder contain the ejs templates
  */
-function updateManifest(basePath, service, fs, templateRoot) {
-    const manifestPath = (0, path_1.join)(basePath, 'webapp', 'manifest.json');
+async function updateManifest(basePath, service, fs, templateRoot) {
+    const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
+    const manifestPath = (0, path_1.join)(webappPath, 'manifest.json');
     // Get component app id
     const manifest = fs.readJSON(manifestPath);
     const appProp = 'sap.app';
     const appid = manifest?.[appProp]?.id;
+    // Check and update existing services
+    await updateExistingServices(webappPath, manifest, fs);
+    const modifiedManifest = fs.readJSON(manifestPath);
     // 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 }));
     }
     const manifestJsonExt = fs.read((0, path_1.join)(templateRoot, 'extend', `manifest.json`));
-    const manifestSettings = Object.assign(service, getModelSettings((0, project_access_1.getMinimumUI5Version)(manifest)));
+    const manifestSettings = Object.assign(service, getModelSettings((0, project_access_1.getMinimumUI5Version)(modifiedManifest)));
     // If the service object includes ejs options, for example 'client' (see: https://ejs.co/#docs),
     // resulting in unexpected behaviour and problems when webpacking. Passing an empty options object prevents this.
     fs.extendJSON(manifestPath, JSON.parse((0, ejs_1.render)(manifestJsonExt, manifestSettings, {})));

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.24.0",
+  "version": "0.24.2",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -38,7 +38,7 @@
     "@types/semver": "7.5.2",
     "fs-extra": "10.0.0",
     "lodash": "4.17.21",
-    "@sap-ux/project-access": "1.28.8"
+    "@sap-ux/project-access": "1.28.9"
   },
   "engines": {
     "node": ">=18.x"

package/templates/extend/manifest.json

@@ -10,15 +10,20 @@
                         <% if (annotations.length) { %>
                             <% annotations.forEach(function(annotation, index) { %>
                                 <% if (annotation.technicalName) { %>
-                                    "<%= annotation.name %>"<% if (index < annotations.length - 1) { %>,<% } %>
+                                    "<%= annotation.name %>"<% if (index < annotations.length - 1 || locals.localAnnotationsName && (!locals.localAnnotationsName.length || locals.localAnnotationsName.length > 0)) { %>,<% } %>
                                 <% } %>
                             <% }); %>
                         <% } else if (annotations.technicalName) { %>
-                            "<%= annotations.name %>"
+                            "<%= annotations.name %>"<% if (locals.localAnnotationsName && (!locals.localAnnotationsName.length || locals.localAnnotationsName.length > 0)) {%>,<%}%><% } %>
+                        <% } %>
+                    <% if (locals.localAnnotationsName && typeof localAnnotationsName !== 'undefined') { %>
+                        <% if (Array.isArray(localAnnotationsName)) { %>
+                            <% localAnnotationsName.forEach(function(localAnnotation, index) { %>
+                                "<%- localAnnotation %>"<% if (index < localAnnotationsName.length - 1){ %>,<% } %>
+                            <% }); %>
+                        <% } else if (localAnnotationsName) { %>
+                                "<%- localAnnotationsName %>"
                         <% } %>
-                    <% if (locals.localAnnotationsName) {%>,<%}%><% } %>
-                    <% if (locals.localAnnotationsName) { %>
-                        "<%- localAnnotationsName %>"
                     <% } %>
                     ]
                     <% if (locals.metadata) { %>,
@@ -50,14 +55,28 @@
                     }
                 <% } %>
             <% } %>
-            <% if (locals.localAnnotationsName) { %>,
-            "<%- localAnnotationsName %>": {
-                "type": "ODataAnnotation",
-                "uri": "annotations/<%- localAnnotationsName %>.xml",
-                "settings": {
-                    "localUri": "annotations/<%- localAnnotationsName %>.xml"
-                }
-            } <% } %>
+            <% if (locals.localAnnotationsName && typeof localAnnotationsName !== 'undefined') { %>,
+                <% if (locals.localAnnotationsName && typeof localAnnotationsName !== 'undefined') { %>
+                    <% if (Array.isArray(localAnnotationsName)) { %>
+                        <% localAnnotationsName.forEach(function(localAnnotation, index) { %>
+                            "<%- localAnnotation %>": {
+                                "type": "ODataAnnotation",
+                                "uri": "annotations/<%- localAnnotation %>.xml",
+                                "settings": {
+                                    "localUri": "annotations/<%- localAnnotation %>.xml"
+                                }
+                            }<% if (index < localAnnotationsName.length - 1){ %>,<% } %>
+                        <% }); %>
+                    <% } else if (localAnnotationsName) { %>
+                        "<%- localAnnotationsName %>": {
+                            "type": "ODataAnnotation",
+                            "uri": "annotations/<%- localAnnotationsName %>.xml",
+                            "settings": {
+                                "localUri": "annotations/<%- localAnnotationsName %>.xml"
+                            }
+                        } <% } %>
+                <% } %>
+            <% } %>
         }
     },
     "sap.ui5": {