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

package/dist/data/defaults.js

@@ -113,7 +113,7 @@ async function enhanceData(basePath, service, fs) {
     // set service type to EDMX if not defined
     service.type = service.type ?? types_1.ServiceType.EDMX;
     /**
-     * In the manifest EJS template, annotation names are used to add annotations to the manifest.json.
+     * In the manifest annotation names are used to add annotations to the manifest.json.
      * For CAP projects, annotations are added to the annotations.cds file instead of the manifest.json.
      * If the service type is EDMX, this function sets the default annotation names to be included in the manifest.json.
      */

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
-    await (0, updates_1.updateManifest)(basePath, service, fs, templateRoot);
+    await (0, updates_1.updateManifest)(basePath, service, fs);
     // Dont extend backend and mockserver middlewares if service type is CDS
     if (isServiceTypeEdmx) {
         await writeEDMXServiceFiles(fs, basePath, paths, templateRoot, service);

package/dist/updates.d.ts

@@ -6,9 +6,8 @@ import type { OdataService, CdsAnnotationsInfo, EdmxAnnotationsInfo } from './ty
  * @param basePath - the root path of an existing UI5 application
  * @param service - the OData service instance
  * @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): Promise<void>;
+export declare function updateManifest(basePath: string, service: OdataService, fs: Editor): Promise<void>;
 /**
  * Writes annotation XML files for EDMX service annotations.
  *

package/dist/updates.js

@@ -7,19 +7,175 @@ exports.updateManifest = updateManifest;
 exports.writeAnnotationXmlFiles = writeAnnotationXmlFiles;
 exports.updateCdsFilesWithAnnotations = updateCdsFilesWithAnnotations;
 exports.updatePackageJson = updatePackageJson;
-const ejs_1 = require("ejs");
 const path_1 = require("path");
 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");
+/**
+ * Enhances manifest.json models with given service data.
+ *
+ * @param {string} serviceName - name of the OData service instance
+ * @param {string} serviceVersion - version of the OData service instance
+ * @param {string} serviceModel - model of the OData service instance
+ * @param {boolean} includeSynchronizationMode - whether to include synchronizationMode for model settings
+ * @param {Manifest} manifest - the manifest.json of the application
+ */
+function enhanceManifestModels(serviceName, serviceVersion, serviceModel, includeSynchronizationMode, manifest) {
+    const models = manifest?.['sap.ui5']?.models ?? {};
+    let modelSettings = {};
+    if (serviceVersion === '4') {
+        if (includeSynchronizationMode) {
+            modelSettings['synchronizationMode'] = 'None';
+        }
+        modelSettings['operationMode'] = 'Server';
+        modelSettings['autoExpandSelect'] = true;
+        modelSettings['earlyRequests'] = true;
+    }
+    if (models[serviceModel]?.settings) {
+        // Merge settings for existing model
+        modelSettings = {
+            ...models[serviceModel].settings,
+            ...modelSettings
+        };
+        models[serviceModel] = {
+            ...models[serviceModel],
+            dataSource: serviceName,
+            preload: true,
+            settings: modelSettings
+        };
+    }
+    else {
+        models[serviceModel] = {
+            dataSource: serviceName,
+            preload: true,
+            settings: modelSettings
+        };
+    }
+    if (manifest['sap.ui5']) {
+        manifest['sap.ui5'] = {
+            ...manifest['sap.ui5'],
+            models
+        };
+    }
+    else {
+        Object.assign(manifest, { 'sap.ui5': { models: { ...models } } });
+    }
+}
+/**
+ * Enhances manifest.json dataSources with given service data.
+ *
+ * @param {string} serviceName - name of the OData service instance
+ * @param {string} servicePath - path of the OData service instance
+ * @param {string} serviceVersion - version of the OData service instance
+ * @param {Manifest} manifest - the manifest.json of the application
+ * @param {string} serviceMetadata - metdata of the OData service instance
+ * @param {EdmxAnnotationsInfo | EdmxAnnotationsInfo[]} serviceRemoteAnnotations - remote annotations of the OData service instance
+ * @param {string | string[]} serviceLocalAnnotations - local annotations of the OData service instance
+ */
+function enhanceManifestDatasources(serviceName, servicePath, serviceVersion, manifest, serviceMetadata, serviceRemoteAnnotations, serviceLocalAnnotations) {
+    const dataSources = manifest?.['sap.app'].dataSources ?? {};
+    // Service annotation names to be stored in service settings of dataSource
+    const annotations = [];
+    // Annotation dataSources used by service - remote and local annotations are handled differently
+    const annotationDataSources = {};
+    // Handle remote annotations used by service
+    if (Array.isArray(serviceRemoteAnnotations)) {
+        serviceRemoteAnnotations.forEach((remoteAnnotation) => {
+            if (remoteAnnotation.name) {
+                annotations.push(remoteAnnotation.name);
+                annotationDataSources[remoteAnnotation.name] = {
+                    uri: `/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations(TechnicalName='${encodeURIComponent(remoteAnnotation.technicalName)}',Version='0001')/$value/`,
+                    type: 'ODataAnnotation',
+                    settings: {
+                        localUri: `localService/${serviceName}/${remoteAnnotation.technicalName}.xml`
+                    }
+                };
+            }
+        });
+    }
+    else if (serviceRemoteAnnotations?.name) {
+        annotations.push(serviceRemoteAnnotations.name);
+        annotationDataSources[serviceRemoteAnnotations.name] = {
+            uri: `/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations(TechnicalName='${encodeURIComponent(serviceRemoteAnnotations.technicalName)}',Version='0001')/$value/`,
+            type: 'ODataAnnotation',
+            settings: {
+                localUri: `localService/${serviceName}/${serviceRemoteAnnotations.technicalName}.xml`
+            }
+        };
+    }
+    // Handle local annotations used by service
+    if (Array.isArray(serviceLocalAnnotations)) {
+        serviceLocalAnnotations.forEach((localAnnotation) => {
+            annotations.push(localAnnotation);
+            annotationDataSources[localAnnotation] = {
+                type: 'ODataAnnotation',
+                uri: `annotations/${localAnnotation}.xml`,
+                settings: {
+                    localUri: `annotations/${localAnnotation}.xml`
+                }
+            };
+        });
+    }
+    else if (serviceLocalAnnotations) {
+        annotations.push(serviceLocalAnnotations);
+        annotationDataSources[serviceLocalAnnotations] = {
+            type: 'ODataAnnotation',
+            uri: `annotations/${serviceLocalAnnotations}.xml`,
+            settings: {
+                localUri: `annotations/${serviceLocalAnnotations}.xml`
+            }
+        };
+    }
+    const settings = {
+        annotations
+    };
+    if (serviceMetadata) {
+        settings['localUri'] = `localService/${serviceName}/metadata.xml`;
+    }
+    if (serviceVersion === '4') {
+        settings['odataVersion'] = '4.0';
+    }
+    else if (serviceVersion === '2') {
+        settings['odataVersion'] = '2.0';
+    }
+    // Create or update service dataSource in manifest.json for service
+    dataSources[serviceName] = {
+        uri: servicePath,
+        type: 'OData',
+        settings
+    };
+    // Create or update service annotation dataSources in manifest.json for service
+    for (const name in annotationDataSources) {
+        const annotationDataSource = annotationDataSources[name];
+        dataSources[name] = annotationDataSource;
+    }
+    // Update manifest.json dataSources
+    manifest['sap.app'].dataSources = dataSources;
+}
+/**
+ * Enhances (creates or updates existing) manifest.json with service data.
+ *
+ * @param {OdataService} service - the OData service instance
+ * @param {Manifest} manifest - the manifest.json of the application
+ */
+function enhanceManifest(service, manifest) {
+    const minimumUi5Version = (0, project_access_1.getMinimumUI5Version)(manifest);
+    // Enhance model settings for service
+    const serviceSettings = Object.assign(service, getModelSettings(minimumUi5Version));
+    if (serviceSettings.name && serviceSettings.path && serviceSettings.model !== undefined) {
+        enhanceManifestDatasources(serviceSettings.name, serviceSettings.path, serviceSettings.version, manifest, serviceSettings.metadata, serviceSettings.annotations, serviceSettings.localAnnotationsName);
+        // Add or update existing service model settings for manifest.json
+        enhanceManifestModels(serviceSettings.name, serviceSettings.version, serviceSettings.model, serviceSettings.includeSynchronizationMode, manifest);
+    }
+}
 /**
  * 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 {ManifestNamespace.DataSource} dataSource - dataSource configuration from manifest.json
  * @param {Editor} fs - the memfs editor instance
  */
 function updateExistingService(webappPath, dataSourceKey, dataSource, fs) {
@@ -47,6 +203,7 @@ function updateExistingService(webappPath, dataSourceKey, dataSource, fs) {
  * @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
+ * @returns modified manifest object.
  */
 async function updateExistingServices(webappPath, manifest, fs) {
     const dataSources = manifest?.['sap.app']?.dataSources;
@@ -63,7 +220,7 @@ async function updateExistingServices(webappPath, manifest, fs) {
             }
         }
     }
-    fs.writeJSON((0, path_1.join)(webappPath, 'manifest.json'), manifest);
+    return manifest;
 }
 /**
  * Internal function that updates the manifest.json based on the given service configuration.
@@ -71,27 +228,23 @@ async function updateExistingServices(webappPath, manifest, fs) {
  * @param basePath - the root path of an existing UI5 application
  * @param service - the OData service instance
  * @param fs - the memfs editor instance
- * @param templateRoot - root folder contain the ejs templates
  */
-async function updateManifest(basePath, service, fs, templateRoot) {
+async function updateManifest(basePath, service, fs) {
     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)(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, {})));
+    // Check and update existing services
+    const modifiedManifest = await updateExistingServices(webappPath, manifest, fs);
+    // Add or update manifest.json with service
+    enhanceManifest(service, modifiedManifest);
+    fs.writeJSON(manifestPath, modifiedManifest);
 }
 /**
  * Updates the cds index or service file with the provided annotations.

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.2",
+  "version": "0.25.1",
   "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.9"
+    "@sap-ux/project-access": "1.28.10"
   },
   "engines": {
     "node": ">=18.x"

package/templates/extend/manifest.json

@@ -1,98 +0,0 @@
-{
-    "sap.app": {
-        "dataSources": {
-            "<%=name%>": {
-                "uri": "<%=path%>",
-                "type": "OData",
-                "settings": {
-                    "annotations": [
-                    <% if (locals.annotations && typeof annotations !== 'undefined') { %>
-                        <% if (annotations.length) { %>
-                            <% annotations.forEach(function(annotation, index) { %>
-                                <% if (annotation.technicalName) { %>
-                                    "<%= annotation.name %>"<% if (index < annotations.length - 1 || locals.localAnnotationsName && (!locals.localAnnotationsName.length || locals.localAnnotationsName.length > 0)) { %>,<% } %>
-                                <% } %>
-                            <% }); %>
-                        <% } else if (annotations.technicalName) { %>
-                            "<%= 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.metadata) { %>,
-                    "localUri": "localService/<%- name %>/metadata.xml" <% } %><%if (version === '4') {%>,
-                    "odataVersion": "4.0"<% } %><%if (version === '2') {%>,
-                    "odataVersion": "2.0"<% } %>
-                }
-            }
-            <% if (locals.annotations && typeof annotations !== 'undefined') { %>
-                <% if (annotations.length && annotations.length > 0) { %>
-                    <% annotations.forEach(function(annotation, index) { %>
-                        <% if (annotation.technicalName) { %>,
-                            "<%= annotation.name %>": {
-                                "uri": "/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations(TechnicalName='<%- encodeURIComponent(annotation.technicalName) %>',Version='0001')/$value/",
-                                "type": "ODataAnnotation",
-                                "settings": {
-                                    "localUri": "localService/<%- name %>/<%- annotation.technicalName %>.xml"
-                                }
-                            }
-                        <% } %>
-                    <% }); %>
-                <% } else if (annotations.technicalName) { %>,
-                    "<%= annotations.name %>": {
-                        "uri": "/sap/opu/odata/IWFND/CATALOGSERVICE;v=2/Annotations(TechnicalName='<%- encodeURIComponent(annotations.technicalName) %>',Version='0001')/$value/",
-                        "type": "ODataAnnotation",
-                        "settings": {
-                            "localUri": "localService/<%- name %>/<%- annotations.technicalName %>.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": {
-        "models": {
-            "<%=model%>": {
-                "dataSource": "<%=name%>",
-                "preload": true,
-                "settings": {<%if (version === '4') {%>
-                    <% if (locals.includeSynchronizationMode) { %>
-                    "synchronizationMode": "None",
-                    <% } %>
-                    "operationMode": "Server",
-                    "autoExpandSelect": true,
-                    "earlyRequests": true<% } %>
-                }
-            }
-        }
-    }
-}