@sap-ux/project-access 1.2.0 → 1.3.0

package/dist/constants.d.ts

@@ -5,5 +5,6 @@ export declare const FileName: {
     readonly Ui5Yaml: "ui5.yaml";
     readonly Ui5LocalYaml: "ui5-local.yaml";
     readonly Ui5MockYaml: "ui5-mock.yaml";
+    readonly UI5DeployYaml: "ui5-deploy.yaml";
 };
 //# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -7,6 +7,7 @@ exports.FileName = {
     Tsconfig: 'tsconfig.json',
     Ui5Yaml: 'ui5.yaml',
     Ui5LocalYaml: 'ui5-local.yaml',
-    Ui5MockYaml: 'ui5-mock.yaml'
+    Ui5MockYaml: 'ui5-mock.yaml',
+    UI5DeployYaml: 'ui5-deploy.yaml'
 };
 //# sourceMappingURL=constants.js.map

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { FileName } from './constants';
-export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject } from './project';
+export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readUi5Yaml } from './project';
 export * from './types';
 //# 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.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.FileName = void 0;
+exports.readUi5Yaml = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.FileName = void 0;
 var constants_1 = require("./constants");
 Object.defineProperty(exports, "FileName", { enumerable: true, get: function () { return constants_1.FileName; } });
 var project_1 = require("./project");
@@ -28,5 +28,6 @@ Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: functio
 Object.defineProperty(exports, "isCapJavaProject", { enumerable: true, get: function () { return project_1.isCapJavaProject; } });
 Object.defineProperty(exports, "isCapNodeJsProject", { enumerable: true, get: function () { return project_1.isCapNodeJsProject; } });
 Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return project_1.loadModuleFromProject; } });
+Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function () { return project_1.readUi5Yaml; } });
 __exportStar(require("./types"), exports);
 //# sourceMappingURL=index.js.map

package/dist/project/index.d.ts

@@ -2,5 +2,5 @@ export { getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJ
 export { getAppProgrammingLanguage } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findProjectRoot, getAppRootFromWebappPath } from './search';
-export { getWebappPath } from './ui5-config';
+export { getWebappPath, readUi5Yaml } from './ui5-config';
 //# sourceMappingURL=index.d.ts.map

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
+exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "getCapModelAndServices", { enumerable: true, get: function () { return cap_1.getCapModelAndServices; } });
 Object.defineProperty(exports, "getCapProjectType", { enumerable: true, get: function () { return cap_1.getCapProjectType; } });
@@ -16,4 +16,5 @@ Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: funct
 Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return search_1.getAppRootFromWebappPath; } });
 var ui5_config_1 = require("./ui5-config");
 Object.defineProperty(exports, "getWebappPath", { enumerable: true, get: function () { return ui5_config_1.getWebappPath; } });
+Object.defineProperty(exports, "readUi5Yaml", { enumerable: true, get: function () { return ui5_config_1.readUi5Yaml; } });
 //# sourceMappingURL=index.js.map

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

@@ -1,4 +1,5 @@
 import type { Editor } from 'mem-fs-editor';
+import { UI5Config } from '@sap-ux/ui5-config';
 /**
  * Get path to webapp.
  *
@@ -7,4 +8,12 @@ import type { Editor } from 'mem-fs-editor';
  * @returns - path to webapp folder
  */
 export declare function getWebappPath(projectRoot: string, memFs?: Editor): Promise<string>;
+/**
+ * Checks if UI5 config yaml file exists and returns its content.
+ *
+ * @param basePath - path to project root
+ * @param fileName - name of yaml file to be read
+ * @returns {UI5Config} UI5 config file in yaml format
+ */
+export declare function readUi5Yaml(basePath: string, fileName: string): Promise<UI5Config>;
 //# sourceMappingURL=ui5-config.d.ts.map

package/dist/project/ui5-config.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getWebappPath = void 0;
+exports.readUi5Yaml = exports.getWebappPath = void 0;
 const path_1 = require("path");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const constants_1 = require("../constants");
@@ -38,4 +38,22 @@ function getWebappPath(projectRoot, memFs) {
     });
 }
 exports.getWebappPath = getWebappPath;
+/**
+ * Checks if UI5 config yaml file exists and returns its content.
+ *
+ * @param basePath - path to project root
+ * @param fileName - name of yaml file to be read
+ * @returns {UI5Config} UI5 config file in yaml format
+ */
+function readUi5Yaml(basePath, fileName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const ui5YamlPath = (0, path_1.join)(basePath, fileName);
+        if (yield (0, file_1.fileExists)(ui5YamlPath)) {
+            const yamlString = yield (0, file_1.readFile)(ui5YamlPath);
+            return yield ui5_config_1.UI5Config.newInstance(yamlString);
+        }
+        throw Error(`File '${fileName}' not found in project '${basePath}'`);
+    });
+}
+exports.readUi5Yaml = readUi5Yaml;
 //# sourceMappingURL=ui5-config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",
@@ -24,7 +24,7 @@
     "node": ">= 14.16.0 < 15.0.0 || >=16.1.0 < 17.0.0 || >=18.0.0 < 19.0.0"
   },
   "dependencies": {
-    "@sap-ux/ui5-config": "0.16.4",
+    "@sap-ux/ui5-config": "0.16.5",
     "findit2": "2.2.3",
     "mem-fs": "2.1.0",
     "mem-fs-editor": "9.4.0"