@sap-ux/project-integrity 0.1.16 → 0.1.18

package/dist/fiori-project/index.js

@@ -12,6 +12,8 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const project_access_1 = require("@sap-ux/project-access");
 const integrity_1 = require("../integrity");
+const hash_1 = require("../integrity/hash");
+const persistence_1 = require("../integrity/persistence");
 exports.fioriIntegrityDataPath = (0, path_1.join)('.fiori-ai/ai-integrity.json');
 /**
  * Get the list of files to protect the integrity of.
@@ -37,6 +39,24 @@ async function getFileList(projectRoot) {
     }
     return fileList;
 }
+/**
+ * Retrieves the Core Schema Notation (CSN) content for a given project root.
+ *
+ * This function generates a JSON string containing the namespace and definitions
+ * from the CSN model of the specified project root.
+ *
+ * @param projectRoot - The root directory of the project.
+ * @returns A promise that resolves to a JSON string containing the CSN content,
+ *          including the namespace and structured clone of the definitions.
+ */
+async function getCsnContent(projectRoot) {
+    const modelFiles = { srv: (0, path_1.join)('srv', 'service.cds'), db: (0, path_1.join)('db', 'schema.cds') };
+    const pathSelection = new Set(Object.keys(modelFiles));
+    const result = await (0, project_access_1.getCapModelAndServices)({ projectRoot, pathSelection });
+    const csn = result.model;
+    const data = { namespace: csn.namespace, definitions: structuredClone(csn.definitions) };
+    return JSON.stringify(data);
+}
 /**
  * Returns additional string content, like the CAP environment.
  * This content will be stored in the integrity data.
@@ -46,7 +66,8 @@ async function getFileList(projectRoot) {
  */
 async function getAdditionalStringContent(projectRoot) {
     const capCustomPaths = await (0, project_access_1.getCapCustomPaths)(projectRoot);
-    return { capPaths: JSON.stringify(capCustomPaths) };
+    const cnsContent = await getCsnContent(projectRoot);
+    return { capPaths: JSON.stringify(capCustomPaths), csn: cnsContent };
 }
 /**
  * Initialize a Fiori project for integrity protection.
@@ -68,7 +89,51 @@ async function initFioriProject(projectRoot) {
 async function checkFioriProjectIntegrity(projectRoot) {
     const integrityFilePath = (0, path_1.join)(projectRoot, exports.fioriIntegrityDataPath);
     const additionalStringContent = await getAdditionalStringContent(projectRoot);
-    return (0, integrity_1.checkProjectIntegrity)(integrityFilePath, additionalStringContent);
+    const checkResult = await (0, integrity_1.checkProjectIntegrity)(integrityFilePath, additionalStringContent);
+    const integrityData = await (0, persistence_1.readIntegrityData)(integrityFilePath);
+    /**
+     * 1. if csn integrity is the same, but file integrity is different, then is compatible changes (e.g empty spaces, new lines or comments). Add them to equal files, update integrity and remove cds files from different files,
+     * 2. if csn integrity is different, but file integrity is same, then CDS compiler might have produced different CSN. Remove csnPath from different content and add it to equal content. Update integrity.
+     * 3. if csn integrity is different and file integrity is different, then it is un-compatible changes. Report them.
+     */
+    const csnDiff = checkResult.additionalStringContent?.differentContent.some((content) => content.key === 'csn');
+    const fileDiff = checkResult.files.differentFiles.some((file) => file.filePath.endsWith('.cds'));
+    if (csnDiff === false && fileDiff === true) {
+        // case 1
+        checkResult.files.equalFiles.push(...checkResult.files.differentFiles.map((file) => file.filePath));
+        // also update integrity.json file
+        const cdsDiffFiles = checkResult.files.differentFiles.filter((file) => file.filePath.endsWith('.cds'));
+        const diffFileIntegrity = await (0, hash_1.getFileIntegrity)(cdsDiffFiles.map((file) => file.filePath));
+        const fileIntegrity = integrityData.fileIntegrity.map((file) => {
+            const diffFile = diffFileIntegrity.find((diff) => diff.filePath === file.filePath);
+            if (diffFile) {
+                return { ...file, hash: diffFile.hash, content: diffFile.content };
+            }
+            return file;
+        });
+        await (0, persistence_1.writeIntegrityData)(integrityFilePath, {
+            enabled: integrityData.enabled,
+            fileIntegrity,
+            contentIntegrity: integrityData.contentIntegrity
+        });
+        // remove cds files from different files
+        checkResult.files.differentFiles = checkResult.files.differentFiles.filter((file) => !file.filePath.endsWith('.cds'));
+    }
+    if (csnDiff === true && fileDiff === false) {
+        // case 2
+        const csnIndex = checkResult.additionalStringContent.differentContent.findIndex((content) => content.key === 'csn');
+        const [csnContent] = checkResult.additionalStringContent.differentContent.splice(csnIndex, 1);
+        checkResult.additionalStringContent.equalContent.push(csnContent.key);
+        // update csn content
+        const contentIntegrity = (0, hash_1.getContentIntegrity)(additionalStringContent);
+        await (0, persistence_1.writeIntegrityData)(integrityFilePath, {
+            enabled: integrityData.enabled,
+            fileIntegrity: integrityData.fileIntegrity,
+            contentIntegrity
+        });
+    }
+    // case 3 or return checkResult of case 1 or 2
+    return checkResult;
 }
 /**
  * Updates the integrity data of a Fiori project.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-integrity",
-  "version": "0.1.16",
+  "version": "0.1.18",
   "description": "Library to check the integrity of projects",
   "repository": {
     "type": "git",
@@ -24,7 +24,7 @@
   },
   "dependencies": {
     "lz-string": "1.5.0",
-    "@sap-ux/project-access": "1.29.18"
+    "@sap-ux/project-access": "1.29.19"
   },
   "scripts": {
     "build": "tsc --build",