@sap-ux/project-access 1.22.1 → 1.22.3

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { FileName, DirName, FioriToolsSettings } from './constants';
 export { getFilePaths } from './file';
-export { createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, toReferenceUri, clearCdsModuleCache } from './project';
+export { addPackageDevDependency, createApplicationAccess, createProjectAccess, findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, toReferenceUri, clearCdsModuleCache, updatePackageScript } from './project';
 export * from './types';
 export * from './library';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,7 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.clearCdsModuleCache = exports.toReferenceUri = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.createProjectAccess = exports.createApplicationAccess = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.updatePackageScript = exports.clearCdsModuleCache = exports.toReferenceUri = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.createProjectAccess = exports.createApplicationAccess = exports.addPackageDevDependency = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 Object.defineProperty(exports, "DirName", { enumerable: true, get: function () { return constants_1.DirName; } });
@@ -22,6 +22,7 @@ Object.defineProperty(exports, "FioriToolsSettings", { enumerable: true, get: fu
 var file_1 = require("./file");
 Object.defineProperty(exports, "getFilePaths", { enumerable: true, get: function () { return file_1.getFilePaths; } });
 var project_1 = require("./project");
+Object.defineProperty(exports, "addPackageDevDependency", { enumerable: true, get: function () { return project_1.addPackageDevDependency; } });
 Object.defineProperty(exports, "createApplicationAccess", { enumerable: true, get: function () { return project_1.createApplicationAccess; } });
 Object.defineProperty(exports, "createProjectAccess", { enumerable: true, get: function () { return project_1.createProjectAccess; } });
 Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return project_1.findAllApps; } });
@@ -56,6 +57,7 @@ Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true,
 Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function () { return project_1.readUi5Yaml; } });
 Object.defineProperty(exports, "toReferenceUri", { enumerable: true, get: function () { return project_1.toReferenceUri; } });
 Object.defineProperty(exports, "clearCdsModuleCache", { enumerable: true, get: function () { return project_1.clearCdsModuleCache; } });
+Object.defineProperty(exports, "updatePackageScript", { enumerable: true, get: function () { return project_1.updatePackageScript; } });
 __exportStar(require("./types"), exports);
 __exportStar(require("./library"), exports);
 //# sourceMappingURL=index.js.map

package/dist/project/dependencies.d.ts

@@ -1,4 +1,5 @@
 import type { Package } from '../types';
+import type { Editor } from 'mem-fs-editor';
 /**
  * Helper to check for dependency/devDependency.
  *
@@ -17,4 +18,13 @@ export declare const hasDependency: (packageJson: Package, dependency: string) =
  * @returns - parent path of node_modules used by project or undefined if node module path was not found
  */
 export declare function getNodeModulesPath(projectRoot: string, module?: string): string | undefined;
+/**
+ * Adds a new dev dependency to the package.json.
+ *
+ * @param basePath - the base path
+ * @param depName - the dependency name
+ * @param depVersion - the dependency version
+ * @param fs - optional memfs editor instance
+ */
+export declare function addPackageDevDependency(basePath: string, depName: string, depVersion: string, fs?: Editor): Promise<void>;
 //# sourceMappingURL=dependencies.d.ts.map

package/dist/project/dependencies.js

@@ -1,9 +1,19 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNodeModulesPath = exports.hasDependency = void 0;
+exports.addPackageDevDependency = exports.getNodeModulesPath = exports.hasDependency = void 0;
 const fs_1 = require("fs");
 const path_1 = require("path");
 const constants_1 = require("../constants");
+const file_1 = require("../file");
 /**
  * Helper to check for dependency/devDependency.
  *
@@ -43,4 +53,25 @@ function getNodeModulesPath(projectRoot, module) {
     return modulesPath;
 }
 exports.getNodeModulesPath = getNodeModulesPath;
+/**
+ * Adds a new dev dependency to the package.json.
+ *
+ * @param basePath - the base path
+ * @param depName - the dependency name
+ * @param depVersion - the dependency version
+ * @param fs - optional memfs editor instance
+ */
+function addPackageDevDependency(basePath, depName, depVersion, fs) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const filePath = (0, path_1.join)(basePath, constants_1.FileName.Package);
+        const packageJson = yield (0, file_1.readJSON)(filePath, fs);
+        packageJson.devDependencies = (_a = packageJson.devDependencies) !== null && _a !== void 0 ? _a : {};
+        if (!packageJson.devDependencies[depName]) {
+            packageJson.devDependencies[depName] = depVersion;
+        }
+        yield (0, file_1.updatePackageJSON)(filePath, packageJson, fs);
+    });
+}
+exports.addPackageDevDependency = addPackageDevDependency;
 //# sourceMappingURL=dependencies.js.map

package/dist/project/index.d.ts

@@ -1,5 +1,5 @@
 export { getCapCustomPaths, getCapModelAndServices, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, isCapProject, isCapJavaProject, isCapNodeJsProject, getCapEnvironment, readCapServiceMetadataEdmx, toReferenceUri, clearCdsModuleCache } from './cap';
-export { getNodeModulesPath } from './dependencies';
+export { addPackageDevDependency, getNodeModulesPath } from './dependencies';
 export { getCapI18nFolderNames, getI18nPropertiesPaths } from './i18n';
 export { getAppProgrammingLanguage, getAppType, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getProject, getProjectType } from './info';
 export { loadModuleFromProject } from './module-loader';
@@ -7,4 +7,5 @@ export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getA
 export { getWebappPath, readUi5Yaml } from './ui5-config';
 export { getMtaPath } from './mta';
 export { createApplicationAccess, createProjectAccess } from './access';
+export { updatePackageScript } from './script';
 //# sourceMappingURL=index.d.ts.map

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getProject = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.clearCdsModuleCache = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
+exports.updatePackageScript = exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findAllApps = exports.loadModuleFromProject = exports.getProjectType = exports.getProject = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getAppType = exports.getAppProgrammingLanguage = exports.getI18nPropertiesPaths = exports.getCapI18nFolderNames = exports.getNodeModulesPath = exports.addPackageDevDependency = exports.clearCdsModuleCache = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapCustomPaths = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "getCapCustomPaths", { enumerable: true, get: function () { return cap_1.getCapCustomPaths; } });
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return cap_1.getCapModelAndServices; } });
@@ -16,6 +16,7 @@ Object.defineProperty(exports, "readCapServiceMetadataEdmx", { enumerable: true,
 Object.defineProperty(exports, "toReferenceUri", { enumerable: true, get: function () { return cap_1.toReferenceUri; } });
 Object.defineProperty(exports, "clearCdsModuleCache", { enumerable: true, get: function () { return cap_1.clearCdsModuleCache; } });
 var dependencies_1 = require("./dependencies");
+Object.defineProperty(exports, "addPackageDevDependency", { enumerable: true, get: function () { return dependencies_1.addPackageDevDependency; } });
 Object.defineProperty(exports, "getNodeModulesPath", { enumerable: true, get: function () { return dependencies_1.getNodeModulesPath; } });
 var i18n_1 = require("./i18n");
 Object.defineProperty(exports, "getCapI18nFolderNames", { enumerable: true, get: function () { return i18n_1.getCapI18nFolderNames; } });
@@ -44,4 +45,6 @@ Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function (
 var access_1 = require("./access");
 Object.defineProperty(exports, "createApplicationAccess", { enumerable: true, get: function () { return access_1.createApplicationAccess; } });
 Object.defineProperty(exports, "createProjectAccess", { enumerable: true, get: function () { return access_1.createProjectAccess; } });
+var script_1 = require("./script");
+Object.defineProperty(exports, "updatePackageScript", { enumerable: true, get: function () { return script_1.updatePackageScript; } });
 //# sourceMappingURL=index.js.map

package/dist/project/script.d.ts

@@ -0,0 +1,11 @@
+import type { Editor } from 'mem-fs-editor';
+/**
+ * Updates the package.json with a new script.
+ *
+ * @param basePath - the base path
+ * @param scriptName - the script name
+ * @param script - the script content
+ * @param fs - optional memfs editor instance
+ */
+export declare function updatePackageScript(basePath: string, scriptName: string, script: string, fs?: Editor): Promise<void>;
+//# sourceMappingURL=script.d.ts.map

package/dist/project/script.js

@@ -0,0 +1,36 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updatePackageScript = void 0;
+const path_1 = require("path");
+const constants_1 = require("../constants");
+const file_1 = require("../file");
+/**
+ * Updates the package.json with a new script.
+ *
+ * @param basePath - the base path
+ * @param scriptName - the script name
+ * @param script - the script content
+ * @param fs - optional memfs editor instance
+ */
+function updatePackageScript(basePath, scriptName, script, fs) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const filePath = (0, path_1.join)(basePath, constants_1.FileName.Package);
+        const packageJson = yield (0, file_1.readJSON)(filePath, fs);
+        if (!packageJson.scripts) {
+            packageJson.scripts = {};
+        }
+        packageJson.scripts[scriptName] = script;
+        yield (0, file_1.updatePackageJSON)(filePath, packageJson, fs);
+    });
+}
+exports.updatePackageScript = updatePackageScript;
+//# sourceMappingURL=script.js.map

package/dist/project/ui5-config.d.ts

@@ -13,7 +13,8 @@ export declare function getWebappPath(projectRoot: string, memFs?: Editor): Prom
  *
  * @param projectRoot - path to project root
  * @param fileName - name of yaml file to be read
+ * @param [memFs] - optional mem-fs editor instance
  * @returns {UI5Config} UI5 config file in yaml format
  */
-export declare function readUi5Yaml(projectRoot: string, fileName: string): Promise<UI5Config>;
+export declare function readUi5Yaml(projectRoot: string, fileName: string, memFs?: Editor): Promise<UI5Config>;
 //# sourceMappingURL=ui5-config.d.ts.map

package/dist/project/ui5-config.js

@@ -43,13 +43,14 @@ exports.getWebappPath = getWebappPath;
  *
  * @param projectRoot - path to project root
  * @param fileName - name of yaml file to be read
+ * @param [memFs] - optional mem-fs editor instance
  * @returns {UI5Config} UI5 config file in yaml format
  */
-function readUi5Yaml(projectRoot, fileName) {
+function readUi5Yaml(projectRoot, fileName, memFs) {
     return __awaiter(this, void 0, void 0, function* () {
         const ui5YamlPath = (0, path_1.join)(projectRoot, fileName);
         if (yield (0, file_1.fileExists)(ui5YamlPath)) {
-            const yamlString = yield (0, file_1.readFile)(ui5YamlPath);
+            const yamlString = yield (0, file_1.readFile)(ui5YamlPath, memFs);
             return yield ui5_config_1.UI5Config.newInstance(yamlString);
         }
         throw Error(`File '${fileName}' not found in project '${projectRoot}'`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.22.1",
+  "version": "1.22.3",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -30,7 +30,7 @@
     "mem-fs-editor": "9.4.0",
     "semver": "7.5.4",
     "@sap-ux/i18n": "0.0.7",
-    "@sap-ux/ui5-config": "0.22.8"
+    "@sap-ux/ui5-config": "0.22.10"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",