@sap-ux/project-access 1.28.7 → 1.28.9

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

@@ -8,6 +8,7 @@ import type { Editor } from 'mem-fs-editor';
  * @param options.root - folder to start recursive search
  * @param [options.excludeFolders] - optional array of folder names to exclude
  * @param [options.memFs] - optional memfs editor instance
+ * @param [options.noTraversal] - optional flag to disable root path traversal
  * @returns - array of paths that contain the file
  */
 export declare function findBy(options: {
@@ -15,6 +16,7 @@ export declare function findBy(options: {
     extensionNames?: string[];
     root: string;
     excludeFolders?: string[];
+    noTraversal?: boolean;
     memFs?: Editor;
 }): Promise<string[]>;
 /**
@@ -34,9 +36,10 @@ export declare function findFiles(filename: string, root: string, excludeFolders
  * @param root - root folder to start search
  * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
  * @param [memFs] - optional mem-fs-editor instance
+ * @param noTraversal - optional flag to disable root path traversal
  * @returns - array of file paths that have the extension
  */
-export declare function findFilesByExtension(extension: string, root: string, excludeFolders: string[], memFs?: Editor): Promise<string[]>;
+export declare function findFilesByExtension(extension: string, root: string, excludeFolders: string[], memFs?: Editor, noTraversal?: boolean): Promise<string[]>;
 /**
  * Find a file by name in parent folders starting from 'startPath'.
  *

package/dist/file/file-search.js

@@ -43,6 +43,7 @@ function getMemFsChanges(changes, fileNames, extensionNames) {
  * @param options.root - folder to start recursive search
  * @param [options.excludeFolders] - optional array of folder names to exclude
  * @param [options.memFs] - optional memfs editor instance
+ * @param [options.noTraversal] - optional flag to disable root path traversal
  * @returns - array of paths that contain the file
  */
 function findBy(options) {
@@ -51,10 +52,11 @@ function findBy(options) {
         const fileNames = Array.isArray(options.fileNames) ? options.fileNames : [];
         const extensionNames = Array.isArray(options.extensionNames) ? options.extensionNames : [];
         const excludeFolders = Array.isArray(options.excludeFolders) ? options.excludeFolders : [];
+        const noTraversal = options.noTraversal ?? false;
         const finder = (0, findit2_1.default)(options.root);
         finder.on('directory', (dir, _stat, stop) => {
             const base = (0, path_1.basename)(dir);
-            if (excludeFolders.includes(base)) {
+            if (excludeFolders.includes(base) || (noTraversal && dir !== options.root)) {
                 stop();
             }
         });
@@ -97,10 +99,11 @@ async function findFiles(filename, root, excludeFolders, memFs) {
  * @param root - root folder to start search
  * @param excludeFolders - list of folder names to exclude (search doesn't traverse into these folders)
  * @param [memFs] - optional mem-fs-editor instance
+ * @param noTraversal - optional flag to disable root path traversal
  * @returns - array of file paths that have the extension
  */
-function findFilesByExtension(extension, root, excludeFolders, memFs) {
-    return findBy({ extensionNames: [extension], root, excludeFolders, memFs });
+function findFilesByExtension(extension, root, excludeFolders, memFs, noTraversal) {
+    return findBy({ extensionNames: [extension], root, excludeFolders, noTraversal, memFs });
 }
 /**
  * Find a file by name in parent folders starting from 'startPath'.

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { FileName, DirName, FioriToolsSettings } from './constants';
 export { getFilePaths } from './file';
-export { addPackageDevDependency, clearCdsModuleCache, createApplicationAccess, createProjectAccess, deleteCapApp, filterDataSourcesByType, findAllApps, findCapProjectRoot, findCapProjects, findFioriArtifacts, findProjectRoot, findRootsForPath, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapServiceName, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getSpecification, getSpecificationPath, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, hasUI5CliV3, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, refreshSpecificationDistTags, toReferenceUri, updatePackageScript } from './project';
+export { addPackageDevDependency, clearCdsModuleCache, createApplicationAccess, createProjectAccess, deleteCapApp, filterDataSourcesByType, findAllApps, findCapProjectRoot, findCapProjects, findFioriArtifacts, findProjectRoot, findRootsForPath, getAllUi5YamlFileNames, getAppRootFromWebappPath, getAppProgrammingLanguage, getAppType, getCapCustomPaths, getCapEnvironment, getCapModelAndServices, getCapServiceName, getCapProjectType, getCdsFiles, getCdsRoots, getCdsServices, getCapI18nFolderNames, getSpecification, getSpecificationPath, getI18nPropertiesPaths, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getMtaPath, getNodeModulesPath, getProject, getProjectType, getWebappPath, hasUI5CliV3, isCapProject, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readCapServiceMetadataEdmx, readUi5Yaml, refreshSpecificationDistTags, toReferenceUri, updatePackageScript } from './project';
 export { execNpmCommand } from './command/npm-command';
 export * from './types';
 export * from './library';

package/dist/index.js

@@ -14,7 +14,8 @@ 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.execNpmCommand = exports.updatePackageScript = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.hasUI5CliV3 = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nPropertiesPaths = exports.getSpecificationPath = exports.getSpecification = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapServiceName = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findRootsForPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findCapProjectRoot = exports.findAllApps = exports.filterDataSourcesByType = exports.deleteCapApp = exports.createProjectAccess = exports.createApplicationAccess = exports.clearCdsModuleCache = exports.addPackageDevDependency = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.updatePackageScript = exports.toReferenceUri = exports.refreshSpecificationDistTags = exports.readUi5Yaml = exports.readCapServiceMetadataEdmx = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.hasUI5CliV3 = exports.getWebappPath = exports.getProjectType = exports.getProject = exports.getNodeModulesPath = exports.getMtaPath = exports.getMinimumUI5Version = exports.getMinUI5VersionAsArray = exports.getMinUI5VersionFromManifest = exports.getI18nPropertiesPaths = exports.getSpecificationPath = exports.getSpecification = exports.getCapI18nFolderNames = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapProjectType = exports.getCapServiceName = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.getAppType = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.getAllUi5YamlFileNames = exports.findRootsForPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findCapProjects = exports.findCapProjectRoot = exports.findAllApps = exports.filterDataSourcesByType = exports.deleteCapApp = exports.createProjectAccess = exports.createApplicationAccess = exports.clearCdsModuleCache = exports.addPackageDevDependency = exports.getFilePaths = exports.FioriToolsSettings = exports.DirName = exports.FileName = void 0;
+exports.execNpmCommand = 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; } });
@@ -34,6 +35,7 @@ Object.defineProperty(exports, "findCapProjects", { enumerable: true, get: funct
 Object.defineProperty(exports, "findFioriArtifacts", { enumerable: true, get: function () { return project_1.findFioriArtifacts; } });
 Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: function () { return project_1.findProjectRoot; } });
 Object.defineProperty(exports, "findRootsForPath", { enumerable: true, get: function () { return project_1.findRootsForPath; } });
+Object.defineProperty(exports, "getAllUi5YamlFileNames", { enumerable: true, get: function () { return project_1.getAllUi5YamlFileNames; } });
 Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return project_1.getAppRootFromWebappPath; } });
 Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return project_1.getAppProgrammingLanguage; } });
 Object.defineProperty(exports, "getAppType", { enumerable: true, get: function () { return project_1.getAppType; } });

package/dist/project/index.d.ts

@@ -5,7 +5,7 @@ export { getCapI18nFolderNames, getI18nPropertiesPaths } from './i18n';
 export { getAppProgrammingLanguage, getAppType, getMinUI5VersionFromManifest, getMinUI5VersionAsArray, getMinimumUI5Version, getProject, getProjectType } from './info';
 export { loadModuleFromProject } from './module-loader';
 export { findAllApps, findCapProjects, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, findCapProjectRoot, findRootsForPath } from './search';
-export { getWebappPath, readUi5Yaml } from './ui5-config';
+export { getWebappPath, readUi5Yaml, getAllUi5YamlFileNames } from './ui5-config';
 export { getMtaPath } from './mta';
 export { createApplicationAccess, createProjectAccess } from './access';
 export { updatePackageScript, hasUI5CliV3 } from './script';

package/dist/project/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.refreshSpecificationDistTags = exports.getSpecificationPath = exports.getSpecification = exports.hasUI5CliV3 = exports.updatePackageScript = exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.readUi5Yaml = exports.getWebappPath = exports.findRootsForPath = exports.findCapProjectRoot = 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.filterDataSourcesByType = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapServiceName = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.deleteCapApp = exports.clearCdsModuleCache = void 0;
+exports.refreshSpecificationDistTags = exports.getSpecificationPath = exports.getSpecification = exports.hasUI5CliV3 = exports.updatePackageScript = exports.createProjectAccess = exports.createApplicationAccess = exports.getMtaPath = exports.getAllUi5YamlFileNames = exports.readUi5Yaml = exports.getWebappPath = exports.findRootsForPath = exports.findCapProjectRoot = 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.filterDataSourcesByType = exports.toReferenceUri = exports.readCapServiceMetadataEdmx = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.isCapProject = exports.getCdsServices = exports.getCdsRoots = exports.getCdsFiles = exports.getCapServiceName = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = exports.getCapCustomPaths = exports.deleteCapApp = exports.clearCdsModuleCache = void 0;
 var cap_1 = require("./cap");
 Object.defineProperty(exports, "clearCdsModuleCache", { enumerable: true, get: function () { return cap_1.clearCdsModuleCache; } });
 Object.defineProperty(exports, "deleteCapApp", { enumerable: true, get: function () { return cap_1.deleteCapApp; } });
@@ -46,6 +46,7 @@ Object.defineProperty(exports, "findRootsForPath", { enumerable: true, get: func
 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; } });
+Object.defineProperty(exports, "getAllUi5YamlFileNames", { enumerable: true, get: function () { return ui5_config_1.getAllUi5YamlFileNames; } });
 var mta_1 = require("./mta");
 Object.defineProperty(exports, "getMtaPath", { enumerable: true, get: function () { return mta_1.getMtaPath; } });
 var access_1 = require("./access");

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

@@ -14,8 +14,21 @@ 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
+ * @param options - options
+ * @param [options.validateSchema] - optional flag to validate the schema of the yaml file
  * @returns {UI5Config} UI5 config file in yaml format
  * @throws {Error} if file is not found
  */
-export declare function readUi5Yaml(projectRoot: string, fileName: string, memFs?: Editor): Promise<UI5Config>;
+export declare function readUi5Yaml(projectRoot: string, fileName: string, memFs?: Editor, options?: {
+    validateSchema: boolean;
+}): Promise<UI5Config>;
+/**
+ * Scans the project directory for ui5 configuration yaml files.
+ *
+ * @param projectRoot - path to project root, where ui5 configuration y*ml files are located
+ * @param [memFs] - optional mem-fs editor instance
+ * @returns list of valid and invalid UI5 configuration yaml file names
+ * @throws {Error} if an error occurs while reading files from projectRoot
+ */
+export declare function getAllUi5YamlFileNames(projectRoot: string, memFs?: Editor): Promise<string[]>;
 //# sourceMappingURL=ui5-config.d.ts.map

package/dist/project/ui5-config.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getWebappPath = getWebappPath;
 exports.readUi5Yaml = readUi5Yaml;
+exports.getAllUi5YamlFileNames = getAllUi5YamlFileNames;
 const path_1 = require("path");
 const ui5_config_1 = require("@sap-ux/ui5-config");
 const constants_1 = require("../constants");
@@ -32,15 +33,34 @@ async function getWebappPath(projectRoot, memFs) {
  * @param projectRoot - path to project root
  * @param fileName - name of yaml file to be read
  * @param [memFs] - optional mem-fs editor instance
+ * @param options - options
+ * @param [options.validateSchema] - optional flag to validate the schema of the yaml file
  * @returns {UI5Config} UI5 config file in yaml format
  * @throws {Error} if file is not found
  */
-async function readUi5Yaml(projectRoot, fileName, memFs) {
+async function readUi5Yaml(projectRoot, fileName, memFs, options) {
     const ui5YamlPath = (0, path_1.join)(projectRoot, fileName);
     if (await (0, file_1.fileExists)(ui5YamlPath, memFs)) {
         const yamlString = await (0, file_1.readFile)(ui5YamlPath, memFs);
-        return await ui5_config_1.UI5Config.newInstance(yamlString);
+        return await ui5_config_1.UI5Config.newInstance(yamlString, { validateSchema: options?.validateSchema });
     }
     throw Error(`File '${fileName}' not found in project '${projectRoot}'`);
 }
+/**
+ * Scans the project directory for ui5 configuration yaml files.
+ *
+ * @param projectRoot - path to project root, where ui5 configuration y*ml files are located
+ * @param [memFs] - optional mem-fs editor instance
+ * @returns list of valid and invalid UI5 configuration yaml file names
+ * @throws {Error} if an error occurs while reading files from projectRoot
+ */
+async function getAllUi5YamlFileNames(projectRoot, memFs) {
+    try {
+        const yamlFilePaths = await (0, file_1.findFilesByExtension)('.yaml', projectRoot, [], memFs, true);
+        return yamlFilePaths.map((path) => (0, path_1.basename)(path));
+    }
+    catch (error) {
+        throw new Error(`There was an error reading files from the directory '${projectRoot}': ${error}`);
+    }
+}
 //# sourceMappingURL=ui5-config.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.28.7",
+  "version": "1.28.9",
   "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.2.0",
-    "@sap-ux/ui5-config": "0.25.2"
+    "@sap-ux/ui5-config": "0.26.0"
   },
   "devDependencies": {
     "@types/mem-fs": "1.1.2",