@sap-ux/project-integrity 0.0.2

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,23 @@
+# @sap-ux/project-integrity
+
+Library that offers functions to detect modifications to a set of files within a project. It also allows to pass addition key -> string values that are stored together with integrity data and can also be checked.
+For specific Fiori project, this module contains convenience functions that take care of building up the file and additional string content list, consumer need just to pass a valid Fiori project root.
+
+## Installation
+Npm   
+`npm install --save @sap-ux/project-integrity`
+
+Yarn   
+`yarn add @sap-ux/project-integrity`
+
+Pnpm   
+`pnpm add @sap-ux/project-integrity`
+
+## Usage
+See usage in `test/` folder.
+
+## Keywords
+* SAP Fiori tools
+* SAP Fiori elements
+* SAP Fiori freestyle
+* Project integrity

package/dist/fiori-project/index.d.ts

@@ -0,0 +1,42 @@
+import type { CheckIntegrityResult } from '../types';
+export declare const fioriIntegrityDataPath: string;
+/**
+ * Initialize a Fiori project for integrity protection.
+ *
+ * @param projectRoot - root folder of the project
+ */
+export declare function initFioriProject(projectRoot: string): Promise<void>;
+/**
+ * Check the integrity of a Fiori project.
+ *
+ * @param projectRoot - root folder of the project
+ * @returns - results of the check
+ */
+export declare function checkFioriProjectIntegrity(projectRoot: string): Promise<CheckIntegrityResult>;
+/**
+ * Updates the integrity data of a Fiori project.
+ *
+ * @param projectRoot - root folder of the project
+ */
+export declare function updateFioriProjectIntegrity(projectRoot: string): Promise<void>;
+/**
+ * Return whether integrity is enabled for a Fiori project.
+ *
+ * @param projectRoot - root folder of the project
+ * @returns true if integrity is enabled, false otherwise
+ */
+export declare function isFioriProjectIntegrityEnabled(projectRoot: string): Promise<boolean>;
+/**
+ * Enable integrity protection for a Fiori project. The Fiori project must be initialized first.
+ * After initialization, Fiori project integrity is enabled by default.
+ *
+ * @param projectRoot - root folder of the project
+ */
+export declare function enableFioriProjectIntegrity(projectRoot: string): Promise<void>;
+/**
+ * Disable integrity protection for a Fiori project. The Fiori project must be initialized first.
+ *
+ * @param projectRoot - root folder of the project
+ */
+export declare function disableFioriProjectIntegrity(projectRoot: string): Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/fiori-project/index.js

@@ -0,0 +1,111 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fioriIntegrityDataPath = void 0;
+exports.initFioriProject = initFioriProject;
+exports.checkFioriProjectIntegrity = checkFioriProjectIntegrity;
+exports.updateFioriProjectIntegrity = updateFioriProjectIntegrity;
+exports.isFioriProjectIntegrityEnabled = isFioriProjectIntegrityEnabled;
+exports.enableFioriProjectIntegrity = enableFioriProjectIntegrity;
+exports.disableFioriProjectIntegrity = disableFioriProjectIntegrity;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const project_access_1 = require("@sap-ux/project-access");
+const integrity_1 = require("../integrity");
+exports.fioriIntegrityDataPath = (0, path_1.join)('.fiori-ai/ai-integrity.json');
+/**
+ * Get the list of files to protect the integrity of.
+ *
+ * @param projectRoot - root folder of the project
+ * @returns - list of file paths
+ */
+async function getFileList(projectRoot) {
+    const fileList = [];
+    const schemaCds = (0, path_1.join)(projectRoot, 'db/schema.cds');
+    if ((0, fs_1.existsSync)(schemaCds)) {
+        fileList.push(schemaCds);
+    }
+    else {
+        throw new Error(`File ${schemaCds} does not exist.`);
+    }
+    const servicesCds = (0, path_1.join)(projectRoot, 'srv/service.cds');
+    if ((0, fs_1.existsSync)(servicesCds)) {
+        fileList.push(servicesCds);
+    }
+    else {
+        throw new Error(`File ${servicesCds} does not exist.`);
+    }
+    return fileList;
+}
+/**
+ * Returns additional string content, like the CAP environment.
+ * This content will be stored in the integrity data.
+ *
+ * @param projectRoot - root folder of the project
+ * @returns - additional content to store in the integrity data
+ */
+async function getAdditionalStringContent(projectRoot) {
+    const capCustomPaths = await (0, project_access_1.getCapCustomPaths)(projectRoot);
+    return { capPaths: JSON.stringify(capCustomPaths) };
+}
+/**
+ * Initialize a Fiori project for integrity protection.
+ *
+ * @param projectRoot - root folder of the project
+ */
+async function initFioriProject(projectRoot) {
+    const integrityFilePath = (0, path_1.join)(projectRoot, exports.fioriIntegrityDataPath);
+    const fileList = await getFileList(projectRoot);
+    const additionalStringContent = await getAdditionalStringContent(projectRoot);
+    await (0, integrity_1.initProject)({ integrityFilePath, fileList, additionalStringContent });
+}
+/**
+ * Check the integrity of a Fiori project.
+ *
+ * @param projectRoot - root folder of the project
+ * @returns - results of the check
+ */
+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);
+}
+/**
+ * Updates the integrity data of a Fiori project.
+ *
+ * @param projectRoot - root folder of the project
+ */
+async function updateFioriProjectIntegrity(projectRoot) {
+    const integrityFilePath = (0, path_1.join)(projectRoot, exports.fioriIntegrityDataPath);
+    const additionalStringContent = await getAdditionalStringContent(projectRoot);
+    await (0, integrity_1.updateProjectIntegrity)(integrityFilePath, additionalStringContent);
+}
+/**
+ * Return whether integrity is enabled for a Fiori project.
+ *
+ * @param projectRoot - root folder of the project
+ * @returns true if integrity is enabled, false otherwise
+ */
+async function isFioriProjectIntegrityEnabled(projectRoot) {
+    const integrityFilePath = (0, path_1.join)(projectRoot, exports.fioriIntegrityDataPath);
+    return (0, integrity_1.isProjectIntegrityEnabled)(integrityFilePath);
+}
+/**
+ * Enable integrity protection for a Fiori project. The Fiori project must be initialized first.
+ * After initialization, Fiori project integrity is enabled by default.
+ *
+ * @param projectRoot - root folder of the project
+ */
+async function enableFioriProjectIntegrity(projectRoot) {
+    const integrityFilePath = (0, path_1.join)(projectRoot, exports.fioriIntegrityDataPath);
+    await (0, integrity_1.enableProjectIntegrity)(integrityFilePath);
+}
+/**
+ * Disable integrity protection for a Fiori project. The Fiori project must be initialized first.
+ *
+ * @param projectRoot - root folder of the project
+ */
+async function disableFioriProjectIntegrity(projectRoot) {
+    const integrityFilePath = (0, path_1.join)(projectRoot, exports.fioriIntegrityDataPath);
+    await (0, integrity_1.disableProjectIntegrity)(integrityFilePath);
+}
+//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { checkProjectIntegrity, disableProjectIntegrity, enableProjectIntegrity, initProject, isProjectIntegrityEnabled, updateProjectIntegrity } from './integrity';
+export { checkFioriProjectIntegrity, disableFioriProjectIntegrity, enableFioriProjectIntegrity, initFioriProject, isFioriProjectIntegrityEnabled, updateFioriProjectIntegrity } from './fiori-project';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateFioriProjectIntegrity = exports.isFioriProjectIntegrityEnabled = exports.initFioriProject = exports.enableFioriProjectIntegrity = exports.disableFioriProjectIntegrity = exports.checkFioriProjectIntegrity = exports.updateProjectIntegrity = exports.isProjectIntegrityEnabled = exports.initProject = exports.enableProjectIntegrity = exports.disableProjectIntegrity = exports.checkProjectIntegrity = void 0;
+var integrity_1 = require("./integrity");
+Object.defineProperty(exports, "checkProjectIntegrity", { enumerable: true, get: function () { return integrity_1.checkProjectIntegrity; } });
+Object.defineProperty(exports, "disableProjectIntegrity", { enumerable: true, get: function () { return integrity_1.disableProjectIntegrity; } });
+Object.defineProperty(exports, "enableProjectIntegrity", { enumerable: true, get: function () { return integrity_1.enableProjectIntegrity; } });
+Object.defineProperty(exports, "initProject", { enumerable: true, get: function () { return integrity_1.initProject; } });
+Object.defineProperty(exports, "isProjectIntegrityEnabled", { enumerable: true, get: function () { return integrity_1.isProjectIntegrityEnabled; } });
+Object.defineProperty(exports, "updateProjectIntegrity", { enumerable: true, get: function () { return integrity_1.updateProjectIntegrity; } });
+var fiori_project_1 = require("./fiori-project");
+Object.defineProperty(exports, "checkFioriProjectIntegrity", { enumerable: true, get: function () { return fiori_project_1.checkFioriProjectIntegrity; } });
+Object.defineProperty(exports, "disableFioriProjectIntegrity", { enumerable: true, get: function () { return fiori_project_1.disableFioriProjectIntegrity; } });
+Object.defineProperty(exports, "enableFioriProjectIntegrity", { enumerable: true, get: function () { return fiori_project_1.enableFioriProjectIntegrity; } });
+Object.defineProperty(exports, "initFioriProject", { enumerable: true, get: function () { return fiori_project_1.initFioriProject; } });
+Object.defineProperty(exports, "isFioriProjectIntegrityEnabled", { enumerable: true, get: function () { return fiori_project_1.isFioriProjectIntegrityEnabled; } });
+Object.defineProperty(exports, "updateFioriProjectIntegrity", { enumerable: true, get: function () { return fiori_project_1.updateFioriProjectIntegrity; } });
+//# sourceMappingURL=index.js.map

package/dist/integrity/check.d.ts

@@ -0,0 +1,10 @@
+import type { CheckIntegrityResult, Content, Integrity } from '../types';
+/**
+ * Check existing integrity data.
+ *
+ * @param integrityData - integrity data
+ * @param [additionalStringContent] - optional additional new string content
+ * @returns - results of the check
+ */
+export declare function checkIntegrity(integrityData: Integrity, additionalStringContent?: Content): Promise<CheckIntegrityResult>;
+//# sourceMappingURL=check.d.ts.map

package/dist/integrity/check.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkIntegrity = checkIntegrity;
+const fs_1 = require("fs");
+const hash_1 = require("./hash");
+/**
+ * Check existing integrity data.
+ *
+ * @param integrityData - integrity data
+ * @param [additionalStringContent] - optional additional new string content
+ * @returns - results of the check
+ */
+async function checkIntegrity(integrityData, additionalStringContent) {
+    return {
+        files: await checkFileIntegrity(integrityData.fileIntegrity),
+        additionalStringContent: checkContentIntegrity(integrityData.contentIntegrity, additionalStringContent)
+    };
+}
+/**
+ * Check an array of file hashes against the current state of the files.
+ *
+ * @param fileIntegrity - array of file integrity data
+ * @returns - results of the check
+ */
+async function checkFileIntegrity(fileIntegrity) {
+    const differentFiles = [];
+    const equalFiles = [];
+    const checkFiles = [];
+    for (const integrity of fileIntegrity) {
+        if (!(0, fs_1.existsSync)(integrity.filePath)) {
+            differentFiles.push({ filePath: integrity.filePath, oldContent: integrity.content, newContent: '' });
+        }
+        else {
+            checkFiles.push(integrity);
+        }
+    }
+    const newFileIntegrityArray = await (0, hash_1.getFileIntegrity)(checkFiles.map((fileIntegrity) => fileIntegrity.filePath));
+    for (const newFileIntegrity of newFileIntegrityArray) {
+        const oldFileIntegrity = checkFiles.find((fileHash) => fileHash.filePath === newFileIntegrity.filePath);
+        if (oldFileIntegrity && oldFileIntegrity.hash === newFileIntegrity.hash) {
+            equalFiles.push(oldFileIntegrity.filePath);
+        }
+        else {
+            differentFiles.push({
+                filePath: newFileIntegrity.filePath,
+                oldContent: oldFileIntegrity?.content,
+                newContent: newFileIntegrity.content
+            });
+        }
+    }
+    return { differentFiles, equalFiles };
+}
+/**
+ * Check old content integrity against new key->string values.
+ *
+ * @param contentIntegrity - existing content integrity from integrity data
+ * @param additionalStringContent - new additional key->string values
+ * @returns - result of the check
+ */
+function checkContentIntegrity(contentIntegrity, additionalStringContent) {
+    const oldContentIntegrityArray = structuredClone(contentIntegrity);
+    const differentContent = [];
+    const equalContent = [];
+    const newContentIntegrityArray = (0, hash_1.getContentIntegrity)(additionalStringContent);
+    for (const newContentIntegrity of newContentIntegrityArray) {
+        const index = oldContentIntegrityArray.findIndex((content) => content.contentKey === newContentIntegrity.contentKey);
+        let foundOldContentIntegrity;
+        if (index > -1) {
+            foundOldContentIntegrity = oldContentIntegrityArray[index];
+            oldContentIntegrityArray.splice(index, 1);
+        }
+        if (foundOldContentIntegrity?.hash === newContentIntegrity.hash) {
+            equalContent.push(newContentIntegrity.contentKey);
+        }
+        else {
+            differentContent.push({
+                key: newContentIntegrity.contentKey,
+                newContent: newContentIntegrity.content,
+                oldContent: foundOldContentIntegrity?.content
+            });
+        }
+    }
+    for (const missingContent of oldContentIntegrityArray) {
+        differentContent.push({
+            key: missingContent.contentKey,
+            newContent: undefined,
+            oldContent: missingContent.content
+        });
+    }
+    return { differentContent, equalContent };
+}
+//# sourceMappingURL=check.js.map

package/dist/integrity/hash.d.ts

@@ -0,0 +1,16 @@
+import type { Content, ContentIntegrity, FileIntegrity } from '../types';
+/**
+ * Returns integrity data for a list of given files.
+ *
+ * @param files - list of files to
+ * @returns - promise that resolves to an array of FileHash objects
+ */
+export declare function getFileIntegrity(files: string[]): Promise<FileIntegrity[]>;
+/**
+ * Returns content integrity data for a map of key/value (string).
+ *
+ * @param additionalStringContent - key value map of additional content to write as integrity data
+ * @returns - array of
+ */
+export declare function getContentIntegrity(additionalStringContent?: Content): ContentIntegrity[];
+//# sourceMappingURL=hash.d.ts.map

package/dist/integrity/hash.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFileIntegrity = getFileIntegrity;
+exports.getContentIntegrity = getContentIntegrity;
+const fs_1 = require("fs");
+const crypto_1 = require("crypto");
+/**
+ * Create a md5 hash for a given file.
+ *
+ * @param filePath - path to file
+ * @returns - promise that resolves to a FileHash object
+ */
+async function computeFileIntegrityData(filePath) {
+    return new Promise((resolve, reject) => {
+        let content = '';
+        const hash = (0, crypto_1.createHash)('md5');
+        const fileStream = (0, fs_1.createReadStream)(filePath);
+        fileStream.on('data', (chunk) => {
+            content += chunk.toString();
+            hash.update(chunk);
+        });
+        fileStream.on('end', () => resolve({ filePath, hash: hash.digest('hex'), content }));
+        fileStream.on('error', (err) => reject(err));
+    });
+}
+/**
+ * Returns integrity data for a list of given files.
+ *
+ * @param files - list of files to
+ * @returns - promise that resolves to an array of FileHash objects
+ */
+async function getFileIntegrity(files) {
+    const nonExistingFiles = files.filter((file) => !(0, fs_1.existsSync)(file));
+    if (nonExistingFiles.length > 0) {
+        throw new Error(`The following files do not exist: ${nonExistingFiles.join(', ')}`);
+    }
+    const promises = files.map(computeFileIntegrityData);
+    return await Promise.all(promises);
+}
+/**
+ * Returns content integrity data for a map of key/value (string).
+ *
+ * @param additionalStringContent - key value map of additional content to write as integrity data
+ * @returns - array of
+ */
+function getContentIntegrity(additionalStringContent) {
+    const contentIntegrity = [];
+    if (additionalStringContent) {
+        for (const contentKey in additionalStringContent) {
+            const content = additionalStringContent[contentKey];
+            contentIntegrity.push({
+                contentKey,
+                hash: (0, crypto_1.createHash)('md5').update(content).digest('hex'),
+                content
+            });
+        }
+    }
+    return contentIntegrity;
+}
+//# sourceMappingURL=hash.js.map

package/dist/integrity/index.d.ts

@@ -0,0 +1,2 @@
+export { checkProjectIntegrity, disableProjectIntegrity, enableProjectIntegrity, initProject, isProjectIntegrityEnabled, updateProjectIntegrity } from './project';
+//# sourceMappingURL=index.d.ts.map

package/dist/integrity/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateProjectIntegrity = exports.isProjectIntegrityEnabled = exports.initProject = exports.enableProjectIntegrity = exports.disableProjectIntegrity = exports.checkProjectIntegrity = void 0;
+var project_1 = require("./project");
+Object.defineProperty(exports, "checkProjectIntegrity", { enumerable: true, get: function () { return project_1.checkProjectIntegrity; } });
+Object.defineProperty(exports, "disableProjectIntegrity", { enumerable: true, get: function () { return project_1.disableProjectIntegrity; } });
+Object.defineProperty(exports, "enableProjectIntegrity", { enumerable: true, get: function () { return project_1.enableProjectIntegrity; } });
+Object.defineProperty(exports, "initProject", { enumerable: true, get: function () { return project_1.initProject; } });
+Object.defineProperty(exports, "isProjectIntegrityEnabled", { enumerable: true, get: function () { return project_1.isProjectIntegrityEnabled; } });
+Object.defineProperty(exports, "updateProjectIntegrity", { enumerable: true, get: function () { return project_1.updateProjectIntegrity; } });
+//# sourceMappingURL=index.js.map

package/dist/integrity/persistence.d.ts

@@ -0,0 +1,18 @@
+import type { Integrity } from '../types';
+/**
+ * Read hashes from a previously stored hash file.
+ * Throws an error if the file does not exist.
+ *
+ * @param integrityFilePath - path to the integrity file
+ * @returns - integrity data
+ */
+export declare function readIntegrityData(integrityFilePath: string): Promise<Integrity>;
+/**
+ * Write file integrity information to file. When storing, use relative paths to the hash file
+ * so the project as whole can be moved without breaking integrity.
+ *
+ * @param integrityFilePath - path to the integrity file
+ * @param content - content to write to the integrity file
+ */
+export declare function writeIntegrityData(integrityFilePath: string, content: Integrity): Promise<void>;
+//# sourceMappingURL=persistence.d.ts.map

package/dist/integrity/persistence.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.readIntegrityData = readIntegrityData;
+exports.writeIntegrityData = writeIntegrityData;
+const promises_1 = require("fs/promises");
+const fs_1 = require("fs");
+const path_1 = require("path");
+const lz_string_1 = require("lz-string");
+/**
+ * Read hashes from a previously stored hash file.
+ * Throws an error if the file does not exist.
+ *
+ * @param integrityFilePath - path to the integrity file
+ * @returns - integrity data
+ */
+async function readIntegrityData(integrityFilePath) {
+    if (!(0, fs_1.existsSync)(integrityFilePath)) {
+        throw new Error(`Integrity file not found at ${integrityFilePath}`);
+    }
+    const content = JSON.parse(await (0, promises_1.readFile)(integrityFilePath, { encoding: 'utf-8' }));
+    const integrityDir = (0, path_1.dirname)(integrityFilePath);
+    for (const fileIntegrity of content.fileIntegrity) {
+        fileIntegrity.filePath = (0, path_1.join)(integrityDir, fileIntegrity.filePath);
+        getifyContent(fileIntegrity);
+    }
+    for (const contentIntegrity of content.contentIntegrity) {
+        getifyContent(contentIntegrity);
+    }
+    return content;
+}
+/**
+ * Write file integrity information to file. When storing, use relative paths to the hash file
+ * so the project as whole can be moved without breaking integrity.
+ *
+ * @param integrityFilePath - path to the integrity file
+ * @param content - content to write to the integrity file
+ */
+async function writeIntegrityData(integrityFilePath, content) {
+    const integrityDir = (0, path_1.dirname)(integrityFilePath);
+    if (!(0, fs_1.existsSync)(integrityDir)) {
+        await (0, promises_1.mkdir)(integrityDir, { recursive: true });
+    }
+    for (const fileIntegrity of content.fileIntegrity) {
+        fileIntegrity.filePath = (0, path_1.relative)(integrityDir, fileIntegrity.filePath);
+        if (typeof fileIntegrity.content === 'string') {
+            fileIntegrity.content = (0, lz_string_1.compressToBase64)(fileIntegrity.content);
+        }
+    }
+    for (const contentIntegrity of content.contentIntegrity) {
+        if (typeof contentIntegrity.content === 'string') {
+            contentIntegrity.content = (0, lz_string_1.compressToBase64)(contentIntegrity.content);
+        }
+    }
+    await (0, promises_1.writeFile)(integrityFilePath, JSON.stringify(content), { encoding: 'utf-8' });
+}
+/**
+ * Wrap content with getter to decompress on first access. Do nothing if the content does not exist.
+ *
+ * @param integrityObject - file or content integrity data with compressed content
+ */
+function getifyContent(integrityObject) {
+    if (typeof integrityObject?.content === 'string') {
+        const compressedContent = integrityObject.content;
+        let content;
+        Object.defineProperty(integrityObject, 'content', {
+            get: () => {
+                if (!content) {
+                    content = (0, lz_string_1.decompressFromBase64)(compressedContent);
+                }
+                return content;
+            },
+            set: () => {
+                // Read-only property, ignore content changes
+            }
+        });
+    }
+}
+//# sourceMappingURL=persistence.js.map

package/dist/integrity/project.d.ts

@@ -0,0 +1,50 @@
+import type { CheckIntegrityResult, Content, ProjectSettings } from '../types';
+/**
+ * Initialize a project by creating hashes for all selected files in the project. There is an option to add
+ * additional key->string content to the integrity data.
+ *
+ * @param settings - settings for the project
+ * @param settings.integrityFilePath - path to file where integrity data will be stored
+ * @param settings.fileList - list of file paths for files to create integrity data for
+ * @param [settings.additionalStringContent] - optional key/string map to add to integrity data
+ */
+export declare function initProject(settings: ProjectSettings): Promise<void>;
+/**
+ * Check the integrity of a project by comparing the stored integrity data with the current state
+ * of the files and additional key->string. Throws an error if the project is not initialized,
+ * which means no integrity data found at 'integrityFilePath'.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ * @param [additionalStringContent] - optional key/string map to add to integrity data
+ * @returns - results of the check
+ */
+export declare function checkProjectIntegrity(integrityFilePath: string, additionalStringContent?: Content): Promise<CheckIntegrityResult>;
+/**
+ * Updates the integrity data of a project. Throws an error if a file or string content is missing
+ * or new.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ * @param additionalStringContent - optional key/string map to add to integrity data
+ */
+export declare function updateProjectIntegrity(integrityFilePath: string, additionalStringContent?: Content): Promise<void>;
+/**
+ * Return whether integrity is enabled for a project.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ * @returns - true if integrity is enabled, false otherwise
+ */
+export declare function isProjectIntegrityEnabled(integrityFilePath: string): Promise<boolean>;
+/**
+ * Enable integrity for a project. The project has to be initialized before enabling integrity. After initialization,
+ * the project integrity is enabled by default.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ */
+export declare function enableProjectIntegrity(integrityFilePath: string): Promise<void>;
+/**
+ * Disable integrity for a project. The project has to be initialized before disabling integrity.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ */
+export declare function disableProjectIntegrity(integrityFilePath: string): Promise<void>;
+//# sourceMappingURL=project.d.ts.map

package/dist/integrity/project.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initProject = initProject;
+exports.checkProjectIntegrity = checkProjectIntegrity;
+exports.updateProjectIntegrity = updateProjectIntegrity;
+exports.isProjectIntegrityEnabled = isProjectIntegrityEnabled;
+exports.enableProjectIntegrity = enableProjectIntegrity;
+exports.disableProjectIntegrity = disableProjectIntegrity;
+const fs_1 = require("fs");
+const hash_1 = require("./hash");
+const persistence_1 = require("./persistence");
+const check_1 = require("./check");
+/**
+ * Function to ensure correct sorting of strings.
+ *
+ * @param a - first value to compare
+ * @param b - second value to compare
+ * @returns - 1 if a is greater than b, -1 if a is less than b, 0 if a is equal to b
+ */
+const sortLocal = (a, b) => a.localeCompare(b);
+/**
+ * Initialize a project by creating hashes for all selected files in the project. There is an option to add
+ * additional key->string content to the integrity data.
+ *
+ * @param settings - settings for the project
+ * @param settings.integrityFilePath - path to file where integrity data will be stored
+ * @param settings.fileList - list of file paths for files to create integrity data for
+ * @param [settings.additionalStringContent] - optional key/string map to add to integrity data
+ */
+async function initProject(settings) {
+    const enabled = true;
+    const fileIntegrity = await (0, hash_1.getFileIntegrity)(settings.fileList);
+    const contentIntegrity = await (0, hash_1.getContentIntegrity)(settings.additionalStringContent);
+    await (0, persistence_1.writeIntegrityData)(settings.integrityFilePath, { enabled, fileIntegrity, contentIntegrity });
+}
+/**
+ * Check the integrity of a project by comparing the stored integrity data with the current state
+ * of the files and additional key->string. Throws an error if the project is not initialized,
+ * which means no integrity data found at 'integrityFilePath'.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ * @param [additionalStringContent] - optional key/string map to add to integrity data
+ * @returns - results of the check
+ */
+async function checkProjectIntegrity(integrityFilePath, additionalStringContent) {
+    const integrityData = await (0, persistence_1.readIntegrityData)(integrityFilePath);
+    if (!integrityData.enabled) {
+        throw new Error(`Integrity is disabled for the project with integrity data ${integrityFilePath}`);
+    }
+    const checkResult = (0, check_1.checkIntegrity)(integrityData, additionalStringContent);
+    return checkResult;
+}
+/**
+ * Updates the integrity data of a project. Throws an error if a file or string content is missing
+ * or new.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ * @param additionalStringContent - optional key/string map to add to integrity data
+ */
+async function updateProjectIntegrity(integrityFilePath, additionalStringContent) {
+    if (!(0, fs_1.existsSync)(integrityFilePath)) {
+        throw new Error(`Integrity data not found at ${integrityFilePath}`);
+    }
+    const integrityData = await (0, persistence_1.readIntegrityData)(integrityFilePath);
+    if (!integrityData.enabled) {
+        throw new Error(`Integrity is disabled for the project with integrity data ${integrityFilePath}`);
+    }
+    const existingContentKeys = integrityData.contentIntegrity.map((content) => content.contentKey).sort(sortLocal);
+    const newContentKeys = Object.keys(additionalStringContent ?? {}).sort(sortLocal);
+    if (existingContentKeys.length !== newContentKeys.length ||
+        !existingContentKeys.every((key, index) => key === newContentKeys[index])) {
+        throw new Error(`There is a mismatch of additional content keys.
+Stored content keys: ${existingContentKeys.join(', ')}
+New content keys: ${newContentKeys.join(', ')}`);
+    }
+    const fileIntegrity = await (0, hash_1.getFileIntegrity)(integrityData.fileIntegrity.map((file) => file.filePath));
+    const contentIntegrity = (0, hash_1.getContentIntegrity)(additionalStringContent);
+    await (0, persistence_1.writeIntegrityData)(integrityFilePath, { enabled: integrityData.enabled, fileIntegrity, contentIntegrity });
+}
+/**
+ * Return whether integrity is enabled for a project.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ * @returns - true if integrity is enabled, false otherwise
+ */
+async function isProjectIntegrityEnabled(integrityFilePath) {
+    if (!(0, fs_1.existsSync)(integrityFilePath)) {
+        throw new Error(`Integrity data not found at ${integrityFilePath}`);
+    }
+    const { enabled } = await (0, persistence_1.readIntegrityData)(integrityFilePath);
+    return enabled;
+}
+/**
+ * Enable integrity for a project. The project has to be initialized before enabling integrity. After initialization,
+ * the project integrity is enabled by default.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ */
+async function enableProjectIntegrity(integrityFilePath) {
+    if (!(0, fs_1.existsSync)(integrityFilePath)) {
+        throw new Error(`Integrity data not found at ${integrityFilePath}`);
+    }
+    const integrityData = await (0, persistence_1.readIntegrityData)(integrityFilePath);
+    if (!integrityData.enabled) {
+        integrityData.enabled = true;
+        await (0, persistence_1.writeIntegrityData)(integrityFilePath, integrityData);
+    }
+}
+/**
+ * Disable integrity for a project. The project has to be initialized before disabling integrity.
+ *
+ * @param integrityFilePath - path to file where integrity data is stored
+ */
+async function disableProjectIntegrity(integrityFilePath) {
+    if (!(0, fs_1.existsSync)(integrityFilePath)) {
+        throw new Error(`Integrity data not found at ${integrityFilePath}`);
+    }
+    const integrityData = await (0, persistence_1.readIntegrityData)(integrityFilePath);
+    if (integrityData.enabled) {
+        integrityData.enabled = false;
+        await (0, persistence_1.writeIntegrityData)(integrityFilePath, integrityData);
+    }
+}
+//# sourceMappingURL=project.js.map

package/dist/types.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Project settings when initializing project integrity.
+ */
+export interface ProjectSettings {
+    /**
+     * Path to the file where integrity data, like hash values, are stored
+     */
+    integrityFilePath: string;
+    /**
+     * List of files to create a hash value for
+     */
+    fileList: string[];
+    /**
+     * List of content (key->string) to create a hash value for
+     */
+    additionalStringContent?: Content;
+}
+/**
+ * Integrity data for a project, stored as JSON in integrity file.
+ */
+export interface Integrity {
+    enabled: boolean;
+    fileIntegrity: FileIntegrity[];
+    contentIntegrity: ContentIntegrity[];
+}
+/**
+ * Integrity data for a file.
+ */
+export interface FileIntegrity {
+    filePath: string;
+    hash: string;
+    content?: string;
+}
+/**
+ * Integrity data for a content (key->string).
+ */
+export interface ContentIntegrity {
+    contentKey: string;
+    hash: string;
+    content?: string;
+}
+/**
+ * Content (key->string) to store in integrity data.
+ */
+export interface Content {
+    [contentKey: string]: string;
+}
+/**
+ * Result of a project integrity check.
+ */
+export interface CheckIntegrityResult {
+    files: {
+        differentFiles: {
+            filePath: string;
+            oldContent?: string;
+            newContent?: string;
+        }[];
+        equalFiles: string[];
+    };
+    additionalStringContent: {
+        differentContent: {
+            key: string;
+            oldContent?: string;
+            newContent?: string;
+        }[];
+        equalContent: string[];
+    };
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@sap-ux/project-integrity",
+  "version": "0.0.2",
+  "description": "Library to check the integrity of projects",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SAP/open-ux-tools.git",
+    "directory": "packages/project-integrity"
+  },
+  "bugs": {
+    "url": "https://github.com/SAP/open-ux-tools/issues?q=is%3Aopen+is%3Aissue+label%3Abug+label%3Aproject-integrity"
+  },
+  "license": "Apache-2.0",
+  "private": false,
+  "main": "dist/index.js",
+  "files": [
+    "dist",
+    "LICENSE",
+    "!dist/*.map",
+    "!dist/**/*.map"
+  ],
+  "engines": {
+    "node": ">=18.x"
+  },
+  "dependencies": {
+    "lz-string": "1.5.0",
+    "@sap-ux/project-access": "1.28.10"
+  },
+  "scripts": {
+    "build": "tsc --build",
+    "clean": "rimraf --glob dist coverage *.tsbuildinfo",
+    "format": "prettier --write '**/*.{js,json,ts,yaml,yml}' --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .ts",
+    "lint:fix": "eslint . --ext .ts --fix",
+    "test": "jest --ci --forceExit --detectOpenHandles --colors",
+    "watch": "tsc --watch"
+  }
+}