@sap-ux/odata-service-writer 0.21.1 → 0.22.0

package/dist/data/defaults.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.enhanceData = void 0;
-const updates_1 = require("../updates");
+const types_1 = require("../types");
 const constants_1 = require("./constants");
 /**
  * Sets the default path for a given service.
@@ -39,13 +39,6 @@ function setDefaultServiceModel(service) {
  * @param {OdataService} service - The service object whose annotations name needs to be set or modified.
  */
 function setDefaultAnnotationsName(service) {
-    /**
-     * In the manifest EJS template, annotation names are referred to for adding annotations to the manifest.json.
-     * For CAP projects, annotations are added to the annotations.cds file and not to the manifest.json.
-     */
-    if ((0, updates_1.serviceIsCds)(service)) {
-        return;
-    }
     const annotations = service.annotations;
     if (annotations?.technicalName && !annotations.name) {
         annotations.name = annotations?.technicalName?.replace(/\//g, '_')?.replace(/^_/, '');
@@ -61,7 +54,16 @@ function enhanceData(service) {
     setDefaultServicePath(service);
     setDefaultServiceName(service);
     setDefaultServiceModel(service);
-    setDefaultAnnotationsName(service);
+    // 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.
+     * 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.
+     */
+    if (service.type === types_1.ServiceType.EDMX) {
+        setDefaultAnnotationsName(service);
+    }
     // enhance preview settings with service configuration
     service.previewSettings = service.previewSettings || {};
     service.previewSettings.path =

package/dist/index.js

@@ -70,10 +70,12 @@ async function generate(basePath, service, fs) {
     const paths = await findProjectFiles(basePath, fs);
     ensureExists(basePath, ['webapp/manifest.json'], fs);
     (0, data_1.enhanceData)(service);
+    // set isServiceTypeEdmx true if service is EDMX
+    const isServiceTypeEdmx = service.type === types_1.ServiceType.EDMX;
     // merge content into existing files
     const templateRoot = (0, path_1.join)(__dirname, '../templates');
     // update cds files with annotations only if service type is CDS and annotations are provided
-    if ((0, updates_1.serviceIsCds)(service) && service.annotations) {
+    if (!isServiceTypeEdmx && service.annotations) {
         await (0, updates_1.updateCdsFilesWithAnnotations)(service.annotations, fs);
     }
     // manifest.json
@@ -82,8 +84,8 @@ async function generate(basePath, service, fs) {
     let ui5Config;
     let ui5LocalConfig;
     let ui5LocalConfigPath;
-    if (!(0, updates_1.serviceIsCds)(service) && paths.ui5Yaml) {
-        // Dont extend backend middlewares if service type is CDS
+    if (isServiceTypeEdmx && paths.ui5Yaml) {
+        // Dont extend backend middlewares if service type is CDS.
         ui5Config = await ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5Yaml));
         try {
             ui5Config.addBackendToFioriToolsProxydMiddleware(service.previewSettings);
@@ -105,7 +107,7 @@ async function generate(basePath, service, fs) {
         }
     }
     // Add mockserver entries
-    if (!(0, updates_1.serviceIsCds)(service) && service.metadata) {
+    if (isServiceTypeEdmx && service.metadata) {
         // mockserver entries are not required if service type is CDS
         // copy existing `ui5.yaml` as starting point for ui5-mock.yaml
         if (paths.ui5Yaml && ui5Config) {
@@ -128,15 +130,18 @@ async function generate(basePath, service, fs) {
             fs.copyTpl((0, path_1.join)(templateRoot, 'add', 'annotation.xml'), (0, path_1.join)(basePath, 'webapp', 'annotations', `${service.localAnnotationsName}.xml`), { ...service, namespaces });
         }
     }
-    // update package.json if required
-    if (paths.packageJson && paths.ui5Yaml) {
+    // update package.json for non-cap applications
+    if (isServiceTypeEdmx && paths.packageJson && paths.ui5Yaml) {
         (0, updates_1.updatePackageJson)(paths.packageJson, fs, !!service.metadata);
     }
-    if (ui5LocalConfigPath && ui5LocalConfig) {
+    if (isServiceTypeEdmx && ui5LocalConfigPath && ui5LocalConfig) {
+        // write ui5 local yaml if service type is not CDS
         fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
     }
     // Write annotation xml if annotations are provided and service type is EDMX
-    (0, updates_1.writeAnnotationXmlFiles)(fs, basePath, service);
+    if (isServiceTypeEdmx) {
+        (0, updates_1.writeAnnotationXmlFiles)(fs, basePath, service);
+    }
     return fs;
 }
 exports.generate = generate;

package/dist/updates.d.ts

@@ -1,12 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
 import type { OdataService, CdsAnnotationsInfo } from './types';
-/**
- * Function to check if the service type is CDS.
- *
- * @param service - the OData service instance
- * @returns true if the service type is CDS
- */
-export declare function serviceIsCds(service: OdataService): boolean;
 /**
  * Internal function that updates the manifest.json based on the given service configuration.
  *

package/dist/updates.js

@@ -26,29 +26,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasUI5CliV3 = exports.updatePackageJson = exports.updateCdsFilesWithAnnotations = exports.writeAnnotationXmlFiles = exports.updateManifest = exports.serviceIsCds = void 0;
+exports.hasUI5CliV3 = exports.updatePackageJson = exports.updateCdsFilesWithAnnotations = exports.writeAnnotationXmlFiles = exports.updateManifest = void 0;
 const ejs_1 = require("ejs");
 const path_1 = __importStar(require("path"));
 const i18n_1 = require("./i18n");
-const types_1 = require("./types");
 const semver_1 = __importDefault(require("semver"));
 const prettify_xml_1 = __importDefault(require("prettify-xml"));
-/**
- * Function to check if the service type is CDS.
- *
- * @param service - the OData service instance
- * @returns true if the service type is CDS
- */
-function serviceIsCds(service) {
-    // if service type is not defined, set EDMX as default
-    let serviceType = service.type;
-    serviceType ||= types_1.ServiceType.EDMX;
-    if (serviceType === types_1.ServiceType.CDS) {
-        return true;
-    }
-    return false;
-}
-exports.serviceIsCds = serviceIsCds;
 /**
  * Internal function that updates the manifest.json based on the given service configuration.
  *
@@ -110,9 +93,6 @@ async function updateCdsIndexOrServiceFile(fs, annotations) {
  * @param {OdataService} service - The OData service information.
  */
 function writeAnnotationXmlFiles(fs, basePath, service) {
-    if (serviceIsCds(service)) {
-        return;
-    }
     // Write annotation xml if annotations are provided and service type is EDMX
     const annotations = service.annotations;
     if (annotations?.xml) {

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.21.1",
+  "version": "0.22.0",
   "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.25.3"
+    "@sap-ux/project-access": "1.25.4"
   },
   "engines": {
     "node": ">=18.x"