@sap-ux/odata-service-writer 0.26.4 → 0.26.6

package/dist/data/annotations.d.ts

@@ -24,12 +24,11 @@ export declare function removeAnnotationsFromCDSFiles(annotations: CdsAnnotation
  * Writes local copies of metadata.xml and local annotations.
  *
  * @param {Editor} fs - the memfs editor instance
- * @param {string} basePath - the root path of an existing UI5 application
  * @param {string} webappPath - the webapp path of an existing UI5 application
  * @param {string} templateRoot - path to the file templates
  * @param {OdataService} service - the OData service instance with EDMX type
  */
-export declare function writeLocalServiceAnnotationXMLFiles(fs: Editor, basePath: string, webappPath: string, templateRoot: string, service: EdmxOdataService): Promise<void>;
+export declare function writeLocalServiceAnnotationXMLFiles(fs: Editor, webappPath: string, templateRoot: string, service: EdmxOdataService): Promise<void>;
 /**
  * Writes local copy of metadata.xml.
  *
@@ -46,7 +45,7 @@ export declare function writeMetadata(fs: Editor, webappPath: string, service: E
  * @param {string} serviceName - Name of The OData service.
  * @param {OdataService} edmxAnnotations - The OData service annotations.
  */
-export declare function removeRemoteServiceAnnotationXmlFiles(fs: Editor, basePath: string, serviceName: string, edmxAnnotations: EdmxAnnotationsInfo | EdmxAnnotationsInfo[]): void;
+export declare function removeRemoteServiceAnnotationXmlFiles(fs: Editor, basePath: string, serviceName: string, edmxAnnotations: EdmxAnnotationsInfo | EdmxAnnotationsInfo[]): Promise<void>;
 /**
  * Writes annotation XML files for EDMX service annotations.
  *
@@ -55,7 +54,7 @@ export declare function removeRemoteServiceAnnotationXmlFiles(fs: Editor, basePa
  * @param {string} serviceName - Name of The OData service.
  * @param {OdataService} edmxAnnotations - The OData service annotations.
  */
-export declare function writeRemoteServiceAnnotationXmlFiles(fs: Editor, basePath: string, serviceName: string, edmxAnnotations: EdmxAnnotationsInfo | EdmxAnnotationsInfo[]): void;
+export declare function writeRemoteServiceAnnotationXmlFiles(fs: Editor, basePath: string, serviceName: string, edmxAnnotations: EdmxAnnotationsInfo | EdmxAnnotationsInfo[]): Promise<void>;
 /**
  * Returns the namespaces parsed from the specified metadata and annotations.
  *

package/dist/data/annotations.js

@@ -14,6 +14,7 @@ const path_1 = require("path");
 const fast_xml_parser_1 = require("fast-xml-parser");
 const i18n_1 = require("../i18n");
 const prettify_xml_1 = __importDefault(require("prettify-xml"));
+const project_access_1 = require("@sap-ux/project-access");
 /**
  * Updates the cds index or service file with the provided annotations.
  * This function takes an Editor instance and cds annotations
@@ -24,7 +25,7 @@ const prettify_xml_1 = __importDefault(require("prettify-xml"));
  * @returns {Promise<void>} A promise that resolves when the cds files have been updated.
  */
 async function updateCdsIndexOrServiceFile(fs, annotations) {
-    const dirPath = (0, path_1.join)(annotations.projectName, 'annotations');
+    const dirPath = (0, path_1.join)(annotations.projectName, project_access_1.DirName.Annotations);
     const annotationPath = (0, path_1.normalize)(dirPath).split(/[\\/]/g).join(path_1.posix.sep);
     const annotationConfig = `\nusing from './${annotationPath}';`;
     // get index and service file paths
@@ -82,7 +83,7 @@ async function updateCdsFilesWithAnnotations(annotations, fs) {
  * @returns {Promise<void>} A promise that resolves when the cds files have been updated.
  */
 async function removeCdsIndexOrServiceFile(fs, annotations) {
-    const dirPath = (0, path_1.join)(annotations.projectName, 'annotations');
+    const dirPath = (0, path_1.join)(annotations.projectName, project_access_1.DirName.Annotations);
     const annotationPath = (0, path_1.normalize)(dirPath).split(/[\\/]/g).join(path_1.posix.sep);
     const annotationConfig = `\nusing from './${annotationPath}';`;
     // Get index and service file paths
@@ -142,18 +143,17 @@ async function removeAnnotationsFromCDSFiles(annotations, fs) {
  * Writes local copies of metadata.xml and local annotations.
  *
  * @param {Editor} fs - the memfs editor instance
- * @param {string} basePath - the root path of an existing UI5 application
  * @param {string} webappPath - the webapp path of an existing UI5 application
  * @param {string} templateRoot - path to the file templates
  * @param {OdataService} service - the OData service instance with EDMX type
  */
-async function writeLocalServiceAnnotationXMLFiles(fs, basePath, webappPath, templateRoot, service) {
+async function writeLocalServiceAnnotationXMLFiles(fs, webappPath, templateRoot, service) {
     // Write metadata.xml file
     await writeMetadata(fs, webappPath, service);
     // Adds local annotations to datasources section of manifest.json and writes the annotations file
     if (service.localAnnotationsName) {
         const namespaces = getAnnotationNamespaces(service);
-        fs.copyTpl((0, path_1.join)(templateRoot, 'add', 'annotation.xml'), (0, path_1.join)(basePath, 'webapp', 'annotations', `${service.localAnnotationsName}.xml`), { ...service, namespaces });
+        fs.copyTpl((0, path_1.join)(templateRoot, 'add', 'annotation.xml'), (0, path_1.join)(webappPath, project_access_1.DirName.Annotations, `${service.localAnnotationsName}.xml`), { ...service, namespaces });
     }
 }
 /**
@@ -166,7 +166,7 @@ async function writeLocalServiceAnnotationXMLFiles(fs, basePath, webappPath, tem
 async function writeMetadata(fs, webappPath, service) {
     if (service.metadata) {
         // mainService should be used in case there is no name defined for service
-        fs.write((0, path_1.join)(webappPath, 'localService', service.name ?? 'mainService', 'metadata.xml'), (0, prettify_xml_1.default)(service.metadata, { indent: 4 }));
+        fs.write((0, path_1.join)(webappPath, project_access_1.DirName.LocalService, service.name ?? 'mainService', 'metadata.xml'), (0, prettify_xml_1.default)(service.metadata, { indent: 4 }));
     }
 }
 /**
@@ -177,19 +177,20 @@ async function writeMetadata(fs, webappPath, service) {
  * @param {string} serviceName - Name of The OData service.
  * @param {OdataService} edmxAnnotations - The OData service annotations.
  */
-function removeRemoteServiceAnnotationXmlFiles(fs, basePath, serviceName, edmxAnnotations) {
+async function removeRemoteServiceAnnotationXmlFiles(fs, basePath, serviceName, edmxAnnotations) {
+    const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
     // Write annotation xml if annotations are provided and service type is EDMX
     if (Array.isArray(edmxAnnotations)) {
         for (const annotationName in edmxAnnotations) {
             const annotation = edmxAnnotations[annotationName];
-            const pathToAnnotationFile = (0, path_1.join)(basePath, 'webapp', 'localService', serviceName, `${annotation.technicalName}.xml`);
+            const pathToAnnotationFile = (0, path_1.join)(webappPath, project_access_1.DirName.LocalService, serviceName, `${annotation.technicalName}.xml`);
             if (fs.exists(pathToAnnotationFile)) {
                 fs.delete(pathToAnnotationFile);
             }
         }
     }
     else if (edmxAnnotations?.xml) {
-        const pathToAnnotationFile = (0, path_1.join)(basePath, 'webapp', 'localService', serviceName, `${edmxAnnotations.technicalName}.xml`);
+        const pathToAnnotationFile = (0, path_1.join)(webappPath, project_access_1.DirName.LocalService, serviceName, `${edmxAnnotations.technicalName}.xml`);
         if (fs.exists(pathToAnnotationFile)) {
             fs.delete(pathToAnnotationFile);
         }
@@ -203,18 +204,19 @@ function removeRemoteServiceAnnotationXmlFiles(fs, basePath, serviceName, edmxAn
  * @param {string} serviceName - Name of The OData service.
  * @param {OdataService} edmxAnnotations - The OData service annotations.
  */
-function writeRemoteServiceAnnotationXmlFiles(fs, basePath, serviceName, edmxAnnotations) {
+async function writeRemoteServiceAnnotationXmlFiles(fs, basePath, serviceName, edmxAnnotations) {
+    const webappPath = await (0, project_access_1.getWebappPath)(basePath, fs);
     // Write annotation xml if annotations are provided and service type is EDMX
     if (Array.isArray(edmxAnnotations)) {
         for (const annotationName in edmxAnnotations) {
             const annotation = edmxAnnotations[annotationName];
             if (annotation?.xml) {
-                fs.write((0, path_1.join)(basePath, 'webapp', 'localService', serviceName, `${annotation.technicalName}.xml`), (0, prettify_xml_1.default)(annotation.xml, { indent: 4 }));
+                fs.write((0, path_1.join)(webappPath, project_access_1.DirName.LocalService, serviceName, `${annotation.technicalName}.xml`), (0, prettify_xml_1.default)(annotation.xml, { indent: 4 }));
             }
         }
     }
     else if (edmxAnnotations?.xml) {
-        fs.write((0, path_1.join)(basePath, 'webapp', 'localService', serviceName, `${edmxAnnotations.technicalName}.xml`), (0, prettify_xml_1.default)(edmxAnnotations.xml, { indent: 4 }));
+        fs.write((0, path_1.join)(webappPath, project_access_1.DirName.LocalService, serviceName, `${edmxAnnotations.technicalName}.xml`), (0, prettify_xml_1.default)(edmxAnnotations.xml, { indent: 4 }));
     }
 }
 /**

package/dist/delete.js

@@ -63,7 +63,7 @@ async function deleteServiceData(basePath, paths, service, fs) {
             ui5MockConfig.removeServiceFromMockServerMiddleware(service.path, serviceAnnotationPaths);
             fs.write(paths.ui5MockYaml, ui5MockConfig.toString());
         }
-        (0, annotations_1.removeRemoteServiceAnnotationXmlFiles)(fs, basePath, service.name, service.annotations);
+        await (0, annotations_1.removeRemoteServiceAnnotationXmlFiles)(fs, basePath, service.name, service.annotations);
     }
 }
 //# sourceMappingURL=delete.js.map

package/dist/update.js

@@ -94,7 +94,7 @@ async function addServicesData(basePath, paths, templateRoot, service, fs) {
                 extendBackendMiddleware(fs, service, ui5MockConfig, paths.ui5MockYaml);
             }
         }
-        await (0, annotations_1.writeLocalServiceAnnotationXMLFiles)(fs, basePath, webappPath, templateRoot, service);
+        await (0, annotations_1.writeLocalServiceAnnotationXMLFiles)(fs, webappPath, templateRoot, service);
     }
     // service update should not trigger the package.json update
     if (paths.packageJson && paths.ui5Yaml) {
@@ -103,7 +103,7 @@ async function addServicesData(basePath, paths, templateRoot, service, fs) {
     if (paths.ui5LocalYaml && ui5LocalConfig) {
         fs.write(paths.ui5LocalYaml, ui5LocalConfig.toString());
     }
-    (0, annotations_1.writeRemoteServiceAnnotationXmlFiles)(fs, basePath, service.name ?? 'mainService', service.annotations);
+    await (0, annotations_1.writeRemoteServiceAnnotationXmlFiles)(fs, basePath, service.name ?? 'mainService', service.annotations);
 }
 /**
  * Updates services data in ui5-*.yaml files.
@@ -155,6 +155,6 @@ async function updateServicesData(basePath, paths, service, fs) {
         await (0, annotations_1.writeMetadata)(fs, webappPath, service);
     }
     // Write new annotations files
-    (0, annotations_1.writeRemoteServiceAnnotationXmlFiles)(fs, basePath, service.name ?? 'mainService', service.annotations);
+    await (0, annotations_1.writeRemoteServiceAnnotationXmlFiles)(fs, basePath, service.name ?? 'mainService', service.annotations);
 }
 //# sourceMappingURL=update.js.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.26.4",
+  "version": "0.26.6",
   "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.8.2",
-    "@sap-ux/project-access": "1.29.9",
+    "@sap-ux/mockserver-config-writer": "0.8.4",
+    "@sap-ux/project-access": "1.29.11",
     "@sap-ux/ui5-config": "0.26.2"
   },
   "devDependencies": {