@sap-ux/odata-service-writer 0.19.1 → 0.20.0

package/dist/data/annotations.js

@@ -14,12 +14,15 @@ const i18n_1 = require("../i18n");
 function getAnnotationNamespaces({ metadata, annotations }) {
     // Enhance service with annotations namespaces
     const schemaNamespaces = metadata ? getNamespaces(metadata) : [];
-    if (annotations === null || annotations === void 0 ? void 0 : annotations.xml) {
+    const edmxAnnotations = annotations;
+    if (edmxAnnotations === null || edmxAnnotations === void 0 ? void 0 : edmxAnnotations.xml) {
         // Parse once
-        const annotationsJson = xmlToJson(annotations.xml);
+        const annotationsJson = xmlToJson(edmxAnnotations.xml);
         return schemaNamespaces.map((schema) => {
             // Check if alias exists in backend annotation file, if so use it
-            const annotationAlias = annotations.xml && schema.namespace ? getAliasFromAnnotation(annotationsJson, schema.namespace) : '';
+            const annotationAlias = edmxAnnotations.xml && schema.namespace
+                ? getAliasFromAnnotation(annotationsJson, schema.namespace)
+                : '';
             if (annotationAlias) {
                 schema.alias = annotationAlias;
             }

package/dist/data/defaults.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.enhanceData = void 0;
+const updates_1 = require("../updates");
 const constants_1 = require("./constants");
 /**
  * Sets the default path for a given service.
@@ -41,9 +42,17 @@ function setDefaultServiceModel(service) {
  * @param {OdataService} service - The service object whose annotations name needs to be set or modified.
  */
 function setDefaultAnnotationsName(service) {
-    var _a, _b, _c, _d;
-    if (((_a = service.annotations) === null || _a === void 0 ? void 0 : _a.technicalName) && !service.annotations.name) {
-        service.annotations.name = (_d = (_c = (_b = service.annotations) === null || _b === void 0 ? void 0 : _b.technicalName) === null || _c === void 0 ? void 0 : _c.replace(/\//g, '_')) === null || _d === void 0 ? void 0 : _d.replace(/^_/, '');
+    var _a, _b;
+    /**
+     * 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 === null || annotations === void 0 ? void 0 : annotations.technicalName) && !annotations.name) {
+        annotations.name = (_b = (_a = annotations === null || annotations === void 0 ? void 0 : annotations.technicalName) === null || _a === void 0 ? void 0 : _a.replace(/\//g, '_')) === null || _b === void 0 ? void 0 : _b.replace(/^_/, '');
     }
 }
 /**

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
-import { OdataService, OdataVersion, ServiceType } from './types';
+import { OdataService, OdataVersion, ServiceType, CdsAnnotationsInfo, EdmxAnnotationsInfo } from './types';
 /**
  * Try finding a package.json and a ui5.yaml for the given project by looking upwards in the folder hierachy.
  *
@@ -21,5 +21,5 @@ export declare function findProjectFiles(basePath: string, fs: Editor): Promise<
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
 declare function generate(basePath: string, service: OdataService, fs?: Editor): Promise<Editor>;
-export { generate, OdataVersion, OdataService, ServiceType };
+export { generate, OdataVersion, OdataService, ServiceType, EdmxAnnotationsInfo, CdsAnnotationsInfo };
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -75,7 +75,6 @@ exports.findProjectFiles = findProjectFiles;
  * @returns {Promise<Editor>} the updated memfs editor instance
  */
 function generate(basePath, service, fs) {
-    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         if (!fs) {
             fs = (0, mem_fs_editor_1.create)((0, mem_fs_1.create)());
@@ -85,13 +84,18 @@ function generate(basePath, service, fs) {
         (0, data_1.enhanceData)(service);
         // 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) {
+            yield (0, updates_1.updateCdsFilesWithAnnotations)(service.annotations, fs);
+        }
         // manifest.json
         (0, updates_1.updateManifest)(basePath, service, fs, templateRoot);
         // update ui5.yaml if it exists
         let ui5Config;
         let ui5LocalConfig;
         let ui5LocalConfigPath;
-        if (paths.ui5Yaml) {
+        if (!(0, updates_1.serviceIsCds)(service) && paths.ui5Yaml) {
+            // Dont extend backend middlewares if service type is CDS 
             ui5Config = yield ui5_config_1.UI5Config.newInstance(fs.read(paths.ui5Yaml));
             try {
                 ui5Config.addBackendToFioriToolsProxydMiddleware(service.previewSettings);
@@ -113,7 +117,8 @@ function generate(basePath, service, fs) {
             }
         }
         // Add mockserver entries
-        if (service.metadata) {
+        if (!(0, updates_1.serviceIsCds)(service) && 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) {
                 const webappPath = yield (0, project_access_1.getWebappPath)(basePath, fs);
@@ -142,9 +147,8 @@ function generate(basePath, service, fs) {
         if (ui5LocalConfigPath && ui5LocalConfig) {
             fs.write(ui5LocalConfigPath, ui5LocalConfig.toString());
         }
-        if ((_a = service.annotations) === null || _a === void 0 ? void 0 : _a.xml) {
-            fs.write((0, path_1.join)(basePath, 'webapp', 'localService', `${service.annotations.technicalName}.xml`), (0, prettify_xml_1.default)(service.annotations.xml, { indent: 4 }));
-        }
+        // Write annotation xml if annotations are provided and service type is EDMX
+        (0, updates_1.writeAnnotationXmlFiles)(fs, basePath, service);
         return fs;
     });
 }

package/dist/types.d.ts

@@ -11,6 +11,44 @@ export declare enum ServiceType {
     EDMX = "edmx",
     CDS = "cds"
 }
+/**
+ * Interface representing information for EDMX annotations.
+ */
+export interface EdmxAnnotationsInfo {
+    /**
+     * Optional name for the annotations.
+     */
+    name?: string;
+    /**
+     * Technical name of the annotations.
+     */
+    technicalName: string;
+    /**
+     * XML content of the annotations.
+     */
+    xml: string;
+}
+/**
+ * Interface representing information for CDS annotations.
+ */
+export interface CdsAnnotationsInfo {
+    /**
+     * The contents to be written into the annotation cds file.
+     */
+    cdsFileContents: string;
+    /**
+     * The path to the cap project.
+     */
+    projectPath: string;
+    /**
+     * The relative path to the app folder within the cap project.
+     */
+    appPath: string;
+    /**
+     * The name of the project.
+     */
+    projectName: string;
+}
 export interface OdataService {
     url?: string;
     client?: string;
@@ -24,11 +62,10 @@ export interface OdataService {
     name?: string;
     model?: string;
     metadata?: string;
-    annotations?: {
-        name?: string;
-        technicalName: string;
-        xml: string;
-    };
+    /**
+     * Annotations can either be EDMX annotations or CDS annotations.
+     */
+    annotations?: EdmxAnnotationsInfo | CdsAnnotationsInfo;
     localAnnotationsName?: string;
     previewSettings?: Partial<ProxyBackend>;
 }

package/dist/updates.d.ts

@@ -1,5 +1,12 @@
 import type { Editor } from 'mem-fs-editor';
-import type { OdataService } from './types';
+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.
  *
@@ -9,6 +16,24 @@ import type { OdataService } from './types';
  * @param templateRoot - root folder contain the ejs templates
  */
 export declare function updateManifest(basePath: string, service: OdataService, fs: Editor, templateRoot: string): void;
+/**
+ * Writes annotation XML files.
+ *
+ * @param {Editor} fs - The memfs editor instance.
+ * @param {string} basePath - The base path of the project.
+ * @param {OdataService} service - The OData service information.
+ */
+export declare function writeAnnotationXmlFiles(fs: Editor, basePath: string, service: OdataService): void;
+/**
+ * Updates cds files with the provided annotations.
+ * This function takes cds annotations and an Editor instance,
+ * then updates the relevant cds files with the given annotations.
+ *
+ * @param {CdsAnnotationsInfo} annotations - The cds annotations info.
+ * @param {Editor} fs - The memfs editor instance
+ * @returns {Promise<void>} A promise that resolves when the cds files have been updated.
+ */
+export declare function updateCdsFilesWithAnnotations(annotations: CdsAnnotationsInfo, fs: Editor): Promise<void>;
 /**
  * Update the package.json with the required middlewares.
  *

package/dist/updates.js

@@ -1,13 +1,63 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 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.updateManifest = void 0;
+exports.hasUI5CliV3 = exports.updatePackageJson = exports.updateCdsFilesWithAnnotations = exports.writeAnnotationXmlFiles = exports.updateManifest = exports.serviceIsCds = void 0;
 const ejs_1 = require("ejs");
-const path_1 = require("path");
+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 || (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.
  *
@@ -18,7 +68,6 @@ const semver_1 = __importDefault(require("semver"));
  */
 function updateManifest(basePath, service, fs, templateRoot) {
     var _a, _b, _c;
-    // manifest.json
     const manifestPath = (0, path_1.join)(basePath, 'webapp', 'manifest.json');
     // Get component app id
     const manifest = fs.readJSON(manifestPath);
@@ -36,6 +85,73 @@ function updateManifest(basePath, service, fs, templateRoot) {
     fs.extendJSON(manifestPath, JSON.parse((0, ejs_1.render)(manifestJsonExt, manifestSettings, {})));
 }
 exports.updateManifest = updateManifest;
+/**
+ * Updates the cds index or service file with the provided annotations.
+ * This function takes an Editor instance and cds annotations
+ * and updates either the index file or the service file with the given annotations.
+ *
+ * @param {Editor} fs - The memfs editor instance
+ * @param {CdsAnnotationsInfo} annotations - The cds annotations info.
+ * @returns {Promise<void>} A promise that resolves when the cds files have been updated.
+ */
+function updateCdsIndexOrServiceFile(fs, annotations) {
+    var _a, _b;
+    return __awaiter(this, void 0, void 0, function* () {
+        const dirPath = (0, path_1.join)(annotations.projectName, 'annotations');
+        const annotationPath = path_1.default.normalize(dirPath).split(/[\\/]/g).join(path_1.default.posix.sep);
+        const annotationConfig = `\nusing from './${annotationPath}';`;
+        // get index and service file paths
+        const indexFilePath = (0, path_1.join)(annotations.projectPath, (_a = annotations.appPath) !== null && _a !== void 0 ? _a : '', 'index.cds');
+        const serviceFilePath = (0, path_1.join)(annotations.projectPath, (_b = annotations.appPath) !== null && _b !== void 0 ? _b : '', 'services.cds');
+        // extend index or service file with annotation config
+        if (indexFilePath && fs.exists(indexFilePath)) {
+            fs.append(indexFilePath, annotationConfig);
+        }
+        else if (fs.exists(serviceFilePath)) {
+            fs.append(serviceFilePath, annotationConfig);
+        }
+        else {
+            fs.write(serviceFilePath, annotationConfig);
+        }
+    });
+}
+/**
+ * Writes annotation XML files.
+ *
+ * @param {Editor} fs - The memfs editor instance.
+ * @param {string} basePath - The base path of the project.
+ * @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 === null || annotations === void 0 ? void 0 : annotations.xml) {
+        fs.write((0, path_1.join)(basePath, 'webapp', 'localService', `${annotations.technicalName}.xml`), (0, prettify_xml_1.default)(annotations.xml, { indent: 4 }));
+    }
+}
+exports.writeAnnotationXmlFiles = writeAnnotationXmlFiles;
+/**
+ * Updates cds files with the provided annotations.
+ * This function takes cds annotations and an Editor instance,
+ * then updates the relevant cds files with the given annotations.
+ *
+ * @param {CdsAnnotationsInfo} annotations - The cds annotations info.
+ * @param {Editor} fs - The memfs editor instance
+ * @returns {Promise<void>} A promise that resolves when the cds files have been updated.
+ */
+function updateCdsFilesWithAnnotations(annotations, fs) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const annotationCdsPath = (0, path_1.join)(annotations.projectPath, (_a = annotations.appPath) !== null && _a !== void 0 ? _a : '', annotations.projectName, 'annotations.cds');
+        // write into annotations.cds file
+        fs.write(annotationCdsPath, annotations.cdsFileContents);
+        yield updateCdsIndexOrServiceFile(fs, annotations);
+    });
+}
+exports.updateCdsFilesWithAnnotations = updateCdsFilesWithAnnotations;
 /**
  * Determines model settings based on the UI5 version.
  *

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.19.1",
+  "version": "0.20.0",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "files": [
@@ -27,8 +27,8 @@
     "mem-fs-editor": "9.4.0",
     "prettify-xml": "1.2.0",
     "semver": "7.5.4",
-    "@sap-ux/mockserver-config-writer": "0.5.2",
-    "@sap-ux/ui5-config": "0.22.4"
+    "@sap-ux/mockserver-config-writer": "0.5.3",
+    "@sap-ux/ui5-config": "0.22.5"
   },
   "devDependencies": {
     "@types/ejs": "3.1.2",
@@ -38,7 +38,7 @@
     "@types/semver": "7.5.2",
     "fs-extra": "10.0.0",
     "lodash": "4.17.21",
-    "@sap-ux/project-access": "1.20.0"
+    "@sap-ux/project-access": "1.21.0"
   },
   "engines": {
     "node": ">=18.x"