@sap-ux/odata-service-writer 0.25.9 → 0.26.0

package/dist/data/annotations.d.ts

@@ -1,4 +1,53 @@
-import type { NamespaceAlias, OdataService } from '../types';
+import type { Editor } from 'mem-fs-editor';
+import type { NamespaceAlias, OdataService, EdmxAnnotationsInfo, EdmxOdataService, CdsAnnotationsInfo } from '../types';
+/**
+ * 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 | CdsAnnotationsInfo[], fs: Editor): Promise<void>;
+/**
+ * Removes annotations from CDS files.
+ * 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 removeAnnotationsFromCDSFiles(annotations: CdsAnnotationsInfo | CdsAnnotationsInfo[], fs: Editor): Promise<void>;
+/**
+ * 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>;
+/**
+ * Removes annotation XML files for EDMX annotations.
+ *
+ * @param {Editor} fs - The memfs editor instance.
+ * @param {string} basePath - The base path of the project.
+ * @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;
+/**
+ * Writes annotation XML files for EDMX service annotations.
+ *
+ * @param {Editor} fs - The memfs editor instance.
+ * @param {string} basePath - The base path of the project.
+ * @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;
 /**
  * Returns the namespaces parsed from the specified metadata and annotations.
  *

package/dist/data/annotations.js

@@ -1,8 +1,208 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateCdsFilesWithAnnotations = updateCdsFilesWithAnnotations;
+exports.removeAnnotationsFromCDSFiles = removeAnnotationsFromCDSFiles;
+exports.writeLocalServiceAnnotationXMLFiles = writeLocalServiceAnnotationXMLFiles;
+exports.removeRemoteServiceAnnotationXmlFiles = removeRemoteServiceAnnotationXmlFiles;
+exports.writeRemoteServiceAnnotationXmlFiles = writeRemoteServiceAnnotationXmlFiles;
 exports.getAnnotationNamespaces = getAnnotationNamespaces;
+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"));
+/**
+ * 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.
+ */
+async function updateCdsIndexOrServiceFile(fs, annotations) {
+    const dirPath = (0, path_1.join)(annotations.projectName, '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
+    const indexFilePath = (0, path_1.join)(annotations.projectPath, annotations.appPath ?? '', 'index.cds');
+    const serviceFilePath = (0, path_1.join)(annotations.projectPath, annotations.appPath ?? '', '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);
+    }
+}
+/**
+ * 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.
+ */
+async function updateCdsFilesWithAnnotations(annotations, fs) {
+    if (Array.isArray(annotations)) {
+        for (const annotationName in annotations) {
+            const annotation = annotations[annotationName];
+            const annotationCdsPath = (0, path_1.join)(annotation.projectPath, annotation.appPath ?? '', annotation.projectName, 'annotations.cds');
+            // write into annotations.cds file
+            if (fs.exists(annotationCdsPath)) {
+                fs.append(annotationCdsPath, annotation.cdsFileContents);
+            }
+            else {
+                fs.write(annotationCdsPath, annotation.cdsFileContents);
+            }
+            await updateCdsIndexOrServiceFile(fs, annotation);
+        }
+    }
+    else {
+        const annotationCdsPath = (0, path_1.join)(annotations.projectPath, annotations.appPath ?? '', annotations.projectName, 'annotations.cds');
+        // write into annotations.cds file
+        fs.write(annotationCdsPath, annotations.cdsFileContents);
+        await updateCdsIndexOrServiceFile(fs, annotations);
+    }
+}
+/**
+ * Removes the cds index or service file with the provided annotations.
+ * This function takes an Editor instance and cds annotations
+ * and deletes either from 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.
+ */
+async function removeCdsIndexOrServiceFile(fs, annotations) {
+    const dirPath = (0, path_1.join)(annotations.projectName, '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
+    const indexFilePath = (0, path_1.join)(annotations.projectPath, annotations.appPath ?? '', 'index.cds');
+    const serviceFilePath = (0, path_1.join)(annotations.projectPath, annotations.appPath ?? '', 'services.cds');
+    // Remove annotation config from index or service file
+    if (indexFilePath && fs.exists(indexFilePath)) {
+        // Read old annotations content and replace it with empty string
+        const initialIndexContent = fs.read(indexFilePath);
+        const updatedContent = initialIndexContent.replace(annotationConfig, '');
+        fs.write(indexFilePath, updatedContent);
+    }
+    else if (fs.exists(serviceFilePath)) {
+        // Read old annotations content and replace it with empty string
+        const initialServiceFileContent = fs.read(serviceFilePath);
+        const updatedContent = initialServiceFileContent.replace(annotationConfig, '');
+        fs.write(serviceFilePath, updatedContent);
+    }
+}
+/**
+ * Removes annotations from CDS files.
+ * 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.
+ */
+async function removeAnnotationsFromCDSFiles(annotations, fs) {
+    if (Array.isArray(annotations)) {
+        for (const annotationName in annotations) {
+            const annotation = annotations[annotationName];
+            const annotationCdsPath = (0, path_1.join)(annotation.projectPath, annotation.appPath ?? '', annotation.projectName, 'annotations.cds');
+            // Remove from annotations.cds file
+            if (fs.exists(annotationCdsPath)) {
+                // Read old annotations content and replace it with empty string
+                const initialCDSContent = fs.read(annotationCdsPath);
+                const updatedContent = initialCDSContent.replace(annotation.cdsFileContents, '');
+                fs.write(annotationCdsPath, updatedContent);
+            }
+            await removeCdsIndexOrServiceFile(fs, annotation);
+        }
+    }
+    else {
+        const annotationCdsPath = (0, path_1.join)(annotations.projectPath, annotations.appPath ?? '', annotations.projectName, 'annotations.cds');
+        // Write into annotations.cds file
+        if (fs.exists(annotationCdsPath)) {
+            // Read old annotations content and replace it with empty string
+            const initialCDSContent = fs.read(annotationCdsPath);
+            const updatedContent = initialCDSContent.replace(annotations.cdsFileContents, '');
+            fs.write(annotationCdsPath, updatedContent);
+        }
+        await removeCdsIndexOrServiceFile(fs, annotations);
+    }
+}
+/**
+ * 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) {
+    // 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 }));
+    // 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 });
+    }
+}
+/**
+ * Removes annotation XML files for EDMX annotations.
+ *
+ * @param {Editor} fs - The memfs editor instance.
+ * @param {string} basePath - The base path of the project.
+ * @param {string} serviceName - Name of The OData service.
+ * @param {OdataService} edmxAnnotations - The OData service annotations.
+ */
+function removeRemoteServiceAnnotationXmlFiles(fs, basePath, serviceName, edmxAnnotations) {
+    // 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`);
+            if (fs.exists(pathToAnnotationFile)) {
+                fs.delete(pathToAnnotationFile);
+            }
+        }
+    }
+    else if (edmxAnnotations?.xml) {
+        const pathToAnnotationFile = (0, path_1.join)(basePath, 'webapp', 'localService', serviceName, `${edmxAnnotations.technicalName}.xml`);
+        if (fs.exists(pathToAnnotationFile)) {
+            fs.delete(pathToAnnotationFile);
+        }
+    }
+}
+/**
+ * Writes annotation XML files for EDMX service annotations.
+ *
+ * @param {Editor} fs - The memfs editor instance.
+ * @param {string} basePath - The base path of the project.
+ * @param {string} serviceName - Name of The OData service.
+ * @param {OdataService} edmxAnnotations - The OData service annotations.
+ */
+function writeRemoteServiceAnnotationXmlFiles(fs, basePath, serviceName, edmxAnnotations) {
+    // 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 }));
+            }
+        }
+    }
+    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 }));
+    }
+}
 /**
  * Returns the namespaces parsed from the specified metadata and single annotation.
  *

package/dist/data/manifest.d.ts

@@ -0,0 +1,20 @@
+import type { Editor } from 'mem-fs-editor';
+import type { OdataService } from '../types';
+/**
+ * Internal function that deletes service from the manifest.json based on the given service data.
+ *
+ * @param basePath - the root path of an existing UI5 application
+ * @param service - name of the OData service instance
+ * @param fs - the memfs editor instance
+ */
+export declare function deleteServiceFromManifest(basePath: string, service: OdataService, fs: Editor): void;
+/**
+ * Updates service data in manifest.json.
+ *
+ * @param {string} basePath - the root path of an existing UI5 application
+ * @param {EdmxOdataService} service - the OData service instance
+ * @param {Editor} fs - the memfs editor instance
+ * @param {boolean} forceServiceUpdate - if true, checks and updates service annotations
+ */
+export declare function updateManifest(basePath: string, service: OdataService, fs: Editor, forceServiceUpdate?: boolean): Promise<void>;
+//# sourceMappingURL=manifest.d.ts.map