@sap-ux/project-access 1.21.2 → 1.22.0

package/dist/file/file-access.d.ts

@@ -1,4 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
+import type { Manifest, Package } from '../types';
 /**
  * Read file asynchronously. Throws error if file does not exist.
  *
@@ -32,4 +33,20 @@ export declare function writeFile(path: string, content: string, memFs?: Editor)
  * @returns - true if the file exists; false otherwise.
  */
 export declare function fileExists(path: string, memFs?: Editor): Promise<boolean>;
+/**
+ * Updates package.json file asynchronously by keeping the previous indentation.
+ *
+ * @param path - path to file
+ * @param packageJson - updated package.json file content
+ * @param memFs - optional mem-fs-editor instance
+ */
+export declare function updatePackageJSON(path: string, packageJson: Package, memFs?: Editor): Promise<void>;
+/**
+ * Updates manifest.json file asynchronously by keeping the previous indentation.
+ *
+ * @param path - path to file
+ * @param manifest - updated manifest.json file content
+ * @param memFs - optional mem-fs-editor instance
+ */
+export declare function updateManifestJSON(path: string, manifest: Manifest, memFs?: Editor): Promise<void>;
 //# sourceMappingURL=file-access.d.ts.map

package/dist/file/file-access.js

@@ -8,9 +8,13 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         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.fileExists = exports.writeFile = exports.readJSON = exports.readFile = void 0;
+exports.updateManifestJSON = exports.updatePackageJSON = exports.fileExists = exports.writeFile = exports.readJSON = exports.readFile = void 0;
 const fs_1 = require("fs");
+const json_parse_even_better_errors_1 = __importDefault(require("json-parse-even-better-errors"));
 /**
  * Read file asynchronously. Throws error if file does not exist.
  *
@@ -88,4 +92,48 @@ function fileExists(path, memFs) {
     });
 }
 exports.fileExists = fileExists;
+/**
+ * Updates package.json file asynchronously by keeping the previous indentation.
+ *
+ * @param path - path to file
+ * @param packageJson - updated package.json file content
+ * @param memFs - optional mem-fs-editor instance
+ */
+function updatePackageJSON(path, packageJson, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield updateJSON(path, packageJson, memFs);
+    });
+}
+exports.updatePackageJSON = updatePackageJSON;
+/**
+ * Updates manifest.json file asynchronously by keeping the previous indentation.
+ *
+ * @param path - path to file
+ * @param manifest - updated manifest.json file content
+ * @param memFs - optional mem-fs-editor instance
+ */
+function updateManifestJSON(path, manifest, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        yield updateJSON(path, manifest, memFs);
+    });
+}
+exports.updateManifestJSON = updateManifestJSON;
+/**
+ * Updates JSON file asynchronously by keeping the indentation from previous content with new content for given path.
+ *
+ * @param path - path to file
+ * @param content - updated JSON file content
+ * @param memFs - optional mem-fs-editor instance
+ */
+function updateJSON(path, content, memFs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // read old contents and indentation of the JSON file
+        const oldContentText = yield readFile(path, memFs);
+        const oldContentJson = (0, json_parse_even_better_errors_1.default)(oldContentText);
+        const indent = Symbol.for('indent');
+        // prepare new JSON file content with previous indentation
+        const result = JSON.stringify(content, null, oldContentJson[indent]) + '\n';
+        yield writeFile(path, result, memFs);
+    });
+}
 //# sourceMappingURL=file-access.js.map

package/dist/file/index.d.ts

@@ -1,3 +1,3 @@
-export { fileExists, readFile, readJSON, writeFile } from './file-access';
+export { fileExists, readFile, readJSON, updatePackageJSON, updateManifestJSON, writeFile } from './file-access';
 export { findBy, findFiles, findFilesByExtension, findFileUp, getFilePaths } from './file-search';
 //# sourceMappingURL=index.d.ts.map

package/dist/file/index.js

@@ -1,10 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFilePaths = exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.findBy = exports.writeFile = exports.readJSON = exports.readFile = exports.fileExists = void 0;
+exports.getFilePaths = exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.findBy = exports.writeFile = exports.updateManifestJSON = exports.updatePackageJSON = exports.readJSON = exports.readFile = exports.fileExists = void 0;
 var file_access_1 = require("./file-access");
 Object.defineProperty(exports, "fileExists", { enumerable: true, get: function () { return file_access_1.fileExists; } });
 Object.defineProperty(exports, "readFile", { enumerable: true, get: function () { return file_access_1.readFile; } });
 Object.defineProperty(exports, "readJSON", { enumerable: true, get: function () { return file_access_1.readJSON; } });
+Object.defineProperty(exports, "updatePackageJSON", { enumerable: true, get: function () { return file_access_1.updatePackageJSON; } });
+Object.defineProperty(exports, "updateManifestJSON", { enumerable: true, get: function () { return file_access_1.updateManifestJSON; } });
 Object.defineProperty(exports, "writeFile", { enumerable: true, get: function () { return file_access_1.writeFile; } });
 var file_search_1 = require("./file-search");
 Object.defineProperty(exports, "findBy", { enumerable: true, get: function () { return file_search_1.findBy; } });

package/dist/project/access.js

@@ -14,6 +14,8 @@ const path_1 = require("path");
 const i18n_1 = require("./i18n");
 const info_1 = require("./info");
 const search_1 = require("./search");
+const file_1 = require("../file");
+const constants_1 = require("../constants");
 /**
  *
  */
@@ -138,6 +140,28 @@ class ApplicationAccessImp {
     getI18nPropertiesPaths() {
         return (0, i18n_1.getI18nPropertiesPaths)(this.app.manifest);
     }
+    /**
+     * Updates package.json file asynchronously by keeping the previous indentation.
+     *
+     * @param packageJson - updated package.json file content
+     * @param memFs - optional mem-fs-editor instance
+     */
+    updatePackageJSON(packageJson, memFs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, file_1.updatePackageJSON)((0, path_1.join)(this.app.appRoot, constants_1.FileName.Package), packageJson, memFs);
+        });
+    }
+    /**
+     * Updates manifest.json file asynchronously by keeping the previous indentation.
+     *
+     * @param manifest - updated manifest.json file content
+     * @param memFs - optional mem-fs-editor instance
+     */
+    updateManifestJSON(manifest, memFs) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield (0, file_1.updateManifestJSON)(this.app.manifest, manifest, memFs);
+        });
+    }
     /**
      * Project structure.
      *

package/dist/types/access/index.d.ts

@@ -1,6 +1,9 @@
 import type { I18nBundles } from '../i18n';
 import type { NewI18nEntry } from '@sap-ux/i18n';
 import type { ApplicationStructure, I18nPropertiesPaths, Project, ProjectType } from '../info';
+import type { Editor } from 'mem-fs-editor';
+import type { Package } from '../package';
+import type { Manifest } from '../webapp';
 interface BaseAccess {
     readonly project: Project;
     readonly root: string;
@@ -92,6 +95,20 @@ export interface ApplicationAccess extends BaseAccess {
      * @returns absolute paths to i18n.properties
      */
     getI18nPropertiesPaths(): Promise<I18nPropertiesPaths>;
+    /**
+     * Updates package.json file asynchronously by keeping the previous indentation.
+     *
+     * @param packageJson - updated package.json file content
+     * @param memFs - optional mem-fs-editor instance
+     */
+    updatePackageJSON(packageJson: Package, memFs?: Editor): Promise<void>;
+    /**
+     * Updates manifest.json file asynchronously by keeping the previous indentation.
+     *
+     * @param manifest - updated manifest.json file content
+     * @param memFs - optional mem-fs-editor instance
+     */
+    updateManifestJSON(manifest: Manifest, memFs?: Editor): Promise<void>;
 }
 export interface ProjectAccess extends BaseAccess {
     getApplicationIds: () => string[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.21.2",
+  "version": "1.22.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -25,6 +25,7 @@
   "dependencies": {
     "fast-xml-parser": "4.2.7",
     "findit2": "2.2.3",
+    "json-parse-even-better-errors": "3.0.2",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0",
     "semver": "7.5.4",