@sap-ux/project-access 1.4.0 → 1.5.0

package/dist/constants.d.ts

@@ -1,5 +1,8 @@
 export declare const FileName: {
+    readonly AdaptationConfig: "config.json";
+    readonly ExtConfigJson: ".extconfig.json";
     readonly Manifest: "manifest.json";
+    readonly ManifestAppDescrVar: "manifest.appdescr_variant";
     readonly Package: "package.json";
     readonly Tsconfig: "tsconfig.json";
     readonly Ui5Yaml: "ui5.yaml";

package/dist/constants.js

@@ -2,7 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileName = void 0;
 exports.FileName = {
+    AdaptationConfig: 'config.json',
+    ExtConfigJson: '.extconfig.json',
     Manifest: 'manifest.json',
+    ManifestAppDescrVar: 'manifest.appdescr_variant',
     Package: 'package.json',
     Tsconfig: 'tsconfig.json',
     Ui5Yaml: 'ui5.yaml',

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

@@ -1,4 +1,22 @@
 import type { Editor } from 'mem-fs-editor';
+/**
+ * Find function to search for files by names or file extensions.
+ *
+ * @param options - find options
+ * @param [options.fileNames] - optional array of file names to search for
+ * @param [options.extensionNames] - optional array of file extensions to search for
+ * @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
+ * @returns - array of paths that contain the file
+ */
+export declare function findBy(options: {
+    fileNames?: string[];
+    extensionNames?: string[];
+    root: string;
+    excludeFolders?: string[];
+    memFs?: Editor;
+}): Promise<string[]>;
 /**
  * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
  *

package/dist/file/file-search.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findFileUp = exports.findFilesByExtension = exports.findFiles = void 0;
+exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.findBy = void 0;
 const path_1 = require("path");
 const findit2_1 = __importDefault(require("findit2"));
 const file_access_1 = require("./file-access");
@@ -20,15 +20,15 @@ const file_access_1 = require("./file-access");
  * Get deleted and modified files from mem-fs editor filtered by query and 'by' (name|extension).
  *
  * @param changes - memfs editor changes, usually retrieved by fs.dump()
- * @param query - search string, file name or file extension
- * @param by - search by file 'name' or file 'extension'
+ * @param fileNames - array of file names to search for
+ * @param extensionNames - array of extensions names to search for
  * @returns - array of deleted and modified files filtered by query
  */
-function getMemFsChanges(changes, query, by) {
+function getMemFsChanges(changes, fileNames, extensionNames) {
     const deleted = [];
     const modified = [];
-    const getFilePartToCompare = by === 'extension' ? path_1.extname : path_1.basename;
-    for (const file of Object.keys(changes).filter((f) => getFilePartToCompare(f) === query)) {
+    const filteredChanges = Object.keys(changes).filter((f) => fileNames.includes((0, path_1.basename)(f)) || extensionNames.includes((0, path_1.extname)(f)));
+    for (const file of filteredChanges) {
         if (changes[file].state === 'deleted') {
             deleted.push((0, path_1.join)(file));
         }
@@ -39,42 +39,41 @@ function getMemFsChanges(changes, query, by) {
     return { deleted, modified };
 }
 /**
- * Find function to search for files.
+ * Find function to search for files by names or file extensions.
  *
  * @param options - find options
- * @param options.query - search string
- * @param options.by - search by file 'name' or file 'extension'
+ * @param [options.fileNames] - optional array of file names to search for
+ * @param [options.extensionNames] - optional array of file extensions to search for
  * @param options.root - folder to start recursive search
- * @param options.excludeFolders - folder names to exclude
+ * @param [options.excludeFolders] - optional array of folder names to exclude
  * @param [options.memFs] - optional memfs editor instance
- * @returns - array of paths that contain the file if searched for name; array of full file paths in case of search by extension
+ * @returns - array of paths that contain the file
  */
 function findBy(options) {
-    const getFilePartToCompare = options.by === 'extension' ? path_1.extname : path_1.basename;
     return new Promise((resolve, reject) => {
         const results = [];
+        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 finder = (0, findit2_1.default)(options.root);
         finder.on('directory', (dir, _stat, stop) => {
             const base = (0, path_1.basename)(dir);
-            if (options.excludeFolders.includes(base)) {
+            if (excludeFolders.includes(base)) {
                 stop();
             }
         });
         finder.on('file', (file) => {
-            if (getFilePartToCompare(file) === options.query) {
+            if (extensionNames.includes((0, path_1.extname)(file)) || fileNames.includes((0, path_1.basename)(file))) {
                 results.push(file);
             }
         });
         finder.on('end', () => {
             let searchResult = results;
             if (options.memFs) {
-                const { modified, deleted } = getMemFsChanges(options.memFs.dump(''), options.query, options.by);
+                const { modified, deleted } = getMemFsChanges(options.memFs.dump(''), fileNames, extensionNames);
                 const merged = Array.from(new Set([...results, ...modified]));
                 searchResult = merged.filter((f) => !deleted.includes(f));
             }
-            if (options.by === 'name') {
-                searchResult = searchResult.map((f) => (0, path_1.dirname)(f));
-            }
             resolve(searchResult);
         });
         finder.on('error', (error) => {
@@ -82,6 +81,7 @@ function findBy(options) {
         });
     });
 }
+exports.findBy = findBy;
 /**
  * Search for 'filename' starting from 'root'. Returns array of paths that contain the file.
  *
@@ -92,7 +92,10 @@ function findBy(options) {
  * @returns - array of paths that contain the filename
  */
 function findFiles(filename, root, excludeFolders, memFs) {
-    return findBy({ query: filename, by: 'name', root, excludeFolders, memFs });
+    return __awaiter(this, void 0, void 0, function* () {
+        const results = yield findBy({ fileNames: [filename], root, excludeFolders, memFs });
+        return results.map((f) => (0, path_1.dirname)(f));
+    });
 }
 exports.findFiles = findFiles;
 /**
@@ -105,7 +108,7 @@ exports.findFiles = findFiles;
  * @returns - array of file paths that have the extension
  */
 function findFilesByExtension(extension, root, excludeFolders, memFs) {
-    return findBy({ query: extension, by: 'extension', root, excludeFolders, memFs });
+    return findBy({ extensionNames: [extension], root, excludeFolders, memFs });
 }
 exports.findFilesByExtension = findFilesByExtension;
 /**

package/dist/file/index.d.ts

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

package/dist/file/index.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.readJSON = exports.readFile = exports.fileExists = void 0;
+exports.findFileUp = exports.findFilesByExtension = exports.findFiles = exports.findBy = 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; } });
 var file_search_1 = require("./file-search");
+Object.defineProperty(exports, "findBy", { enumerable: true, get: function () { return file_search_1.findBy; } });
 Object.defineProperty(exports, "findFiles", { enumerable: true, get: function () { return file_search_1.findFiles; } });
 Object.defineProperty(exports, "findFilesByExtension", { enumerable: true, get: function () { return file_search_1.findFilesByExtension; } });
 Object.defineProperty(exports, "findFileUp", { enumerable: true, get: function () { return file_search_1.findFileUp; } });

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { FileName } from './constants';
-export { findAllApps, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapEnvironment, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readUi5Yaml } from './project';
+export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath, getAppProgrammingLanguage, getCapEnvironment, getCapModelAndServices, getCapProjectType, getWebappPath, isCapJavaProject, isCapNodeJsProject, loadModuleFromProject, readUi5Yaml } from './project';
 export * from './types';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -14,11 +14,12 @@ 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.readUi5Yaml = exports.loadModuleFromProject = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getWebappPath = exports.getCapProjectType = exports.getCapModelAndServices = exports.getCapEnvironment = 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.getCapEnvironment = exports.getAppProgrammingLanguage = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = 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");
 Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return project_1.findAllApps; } });
+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, "getAppRootFromWebappPath", { enumerable: true, get: function () { return project_1.getAppRootFromWebappPath; } });
 Object.defineProperty(exports, "getAppProgrammingLanguage", { enumerable: true, get: function () { return project_1.getAppProgrammingLanguage; } });

package/dist/project/index.d.ts

@@ -1,6 +1,6 @@
 export { getCapModelAndServices, getCapProjectType, isCapJavaProject, isCapNodeJsProject, getCapEnvironment } from './cap';
 export { getAppProgrammingLanguage } from './info';
 export { loadModuleFromProject } from './module-loader';
-export { findAllApps, findProjectRoot, getAppRootFromWebappPath } from './search';
+export { findAllApps, findFioriArtifacts, findProjectRoot, getAppRootFromWebappPath } from './search';
 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.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.getCapEnvironment = exports.isCapNodeJsProject = exports.isCapJavaProject = exports.getCapProjectType = exports.getCapModelAndServices = void 0;
+exports.readUi5Yaml = exports.getWebappPath = exports.getAppRootFromWebappPath = exports.findProjectRoot = exports.findFioriArtifacts = exports.findAllApps = exports.loadModuleFromProject = exports.getAppProgrammingLanguage = exports.getCapEnvironment = 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; } });
@@ -13,6 +13,7 @@ var module_loader_1 = require("./module-loader");
 Object.defineProperty(exports, "loadModuleFromProject", { enumerable: true, get: function () { return module_loader_1.loadModuleFromProject; } });
 var search_1 = require("./search");
 Object.defineProperty(exports, "findAllApps", { enumerable: true, get: function () { return search_1.findAllApps; } });
+Object.defineProperty(exports, "findFioriArtifacts", { enumerable: true, get: function () { return search_1.findFioriArtifacts; } });
 Object.defineProperty(exports, "findProjectRoot", { enumerable: true, get: function () { return search_1.findProjectRoot; } });
 Object.defineProperty(exports, "getAppRootFromWebappPath", { enumerable: true, get: function () { return search_1.getAppRootFromWebappPath; } });
 var ui5_config_1 = require("./ui5-config");

package/dist/project/search.d.ts

@@ -1,4 +1,4 @@
-import type { AllAppResults, WorkspaceFolder } from '../types';
+import type { AllAppResults, FioriArtifactTypes, FoundFioriArtifacts, WorkspaceFolder } from '../types';
 /**
  * Find root folder of the project containing the given file.
  *
@@ -16,9 +16,23 @@ export declare function findProjectRoot(path: string, sapuxRequired?: boolean, s
 export declare function getAppRootFromWebappPath(webappPath: string): Promise<string | null>;
 /**
  * Find all app that are supported by Fiori tools for a given list of roots (workspace folders).
+ * This is a convenient function to retrieve all apps. Same result can be achieved with call
+ * findFioriArtifacts({ wsFolders, artifacts: ['applications'] }); from same module.
  *
  * @param wsFolders - list of roots, either as vscode WorkspaceFolder[] or array of paths
  * @returns - results as path to apps plus files already parsed, e.g. manifest.json
  */
 export declare function findAllApps(wsFolders: WorkspaceFolder[] | string[] | undefined): Promise<AllAppResults[]>;
+/**
+ * Find all requested Fiori artifacts like apps, adaptations, extensions, that are supported by Fiori tools, for a given list of roots (workspace folders).
+ *
+ * @param options - find options
+ * @param options.wsFolders - list of roots, either as vscode WorkspaceFolder[] or array of paths
+ * @param options.artifacts - list of artifacts to search for: 'application', 'adaptation', 'extension' see FioriArtifactTypes
+ * @returns - data structure containing the search results, for app e.g. as path to app plus files already parsed, e.g. manifest.json
+ */
+export declare function findFioriArtifacts(options: {
+    wsFolders?: WorkspaceFolder[] | string[];
+    artifacts: FioriArtifactTypes[];
+}): Promise<FoundFioriArtifacts>;
 //# sourceMappingURL=search.d.ts.map

package/dist/project/search.js

@@ -9,13 +9,29 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findAllApps = exports.getAppRootFromWebappPath = exports.findProjectRoot = void 0;
+exports.findFioriArtifacts = exports.findAllApps = exports.getAppRootFromWebappPath = exports.findProjectRoot = void 0;
 const path_1 = require("path");
 const constants_1 = require("../constants");
 const file_1 = require("../file");
 const dependencies_1 = require("./dependencies");
 const cap_1 = require("./cap");
 const ui5_config_1 = require("./ui5-config");
+/**
+ * Map artifact to file that is specific to the artifact type. Some artifacts can
+ * be identified by the same file, like app and library have file 'manifest.json'.
+ * Further filtering for specific artifact types happens in the filter{Artifact}
+ * functions.
+ */
+const filterFileMap = {
+    applications: constants_1.FileName.Manifest,
+    adaptations: constants_1.FileName.ManifestAppDescrVar,
+    extensions: constants_1.FileName.ExtConfigJson,
+    libraries: constants_1.FileName.Manifest
+};
+/**
+ * Default folders to exclude from search.
+ */
+const excludeFolders = ['.git', 'node_modules', 'dist'];
 /**
  * WorkspaceFolder type guard.
  *
@@ -26,39 +42,26 @@ function isWorkspaceFolder(value) {
     return value && value.length > 0 && value[0].uri !== undefined;
 }
 /**
- * Search all manifest.json files in given workspaces. This is used as starting point to find all tools
- * supported apps.
+ * Convert workspace root folders to root paths.
  *
- * @param wsFolders - workspace folders
- * @returns - array of path to manifest.json files
+ * @param wsFolders - list of roots, either as vscode WorkspaceFolder[] or array of paths
+ * @returns - root paths
  */
-function findAllManifest(wsFolders) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // extract root path if provided as VSCode folder
-        let wsRoots;
-        if (wsFolders && isWorkspaceFolder(wsFolders)) {
-            wsRoots = [];
-            wsFolders
-                .filter((each) => each.uri.scheme === 'file')
-                .forEach((folder) => {
-                wsRoots.push(folder.uri.fsPath);
-            });
-        }
-        else {
-            wsRoots = wsFolders || [];
-        }
-        // find all manifest files
-        const manifests = [];
-        for (const root of wsRoots) {
-            try {
-                manifests.push(...(yield (0, file_1.findFiles)(constants_1.FileName.Manifest, root, ['.git', 'node_modules', 'dist'])));
-            }
-            catch (_a) {
-                // ignore exceptions during find
-            }
-        }
-        return manifests;
-    });
+function wsFoldersToRootPaths(wsFolders) {
+    // extract root path if provided as VSCode folder
+    let wsRoots;
+    if (wsFolders && isWorkspaceFolder(wsFolders)) {
+        wsRoots = [];
+        wsFolders
+            .filter((each) => each.uri.scheme === 'file')
+            .forEach((folder) => {
+            wsRoots.push(folder.uri.fsPath);
+        });
+    }
+    else {
+        wsRoots = wsFolders || [];
+    }
+    return wsRoots;
 }
 /**
  * Find root folder of the project containing the given file.
@@ -211,32 +214,197 @@ function findRootsForPath(path) {
 }
 /**
  * Find all app that are supported by Fiori tools for a given list of roots (workspace folders).
+ * This is a convenient function to retrieve all apps. Same result can be achieved with call
+ * findFioriArtifacts({ wsFolders, artifacts: ['applications'] }); from same module.
  *
  * @param wsFolders - list of roots, either as vscode WorkspaceFolder[] or array of paths
  * @returns - results as path to apps plus files already parsed, e.g. manifest.json
  */
 function findAllApps(wsFolders) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const findResults = yield findFioriArtifacts({ wsFolders, artifacts: ['applications'] });
+        return (_a = findResults.applications) !== null && _a !== void 0 ? _a : [];
+    });
+}
+exports.findAllApps = findAllApps;
+/**
+ * Filter Fiori apps from a list of files.
+ *
+ * @param pathMap - map of files. Key is the path, on first read parsed content will be set as value to prevent multiple reads of a file.
+ * @returns - results as path to apps plus files already parsed, e.g. manifest.json
+ */
+function filterApplications(pathMap) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         const result = [];
-        const manifestPaths = yield findAllManifest(wsFolders);
+        const manifestPaths = Object.keys(pathMap).filter((path) => (0, path_1.basename)(path) === constants_1.FileName.Manifest);
         for (const manifestPath of manifestPaths) {
             try {
                 // All UI5 apps have at least sap.app: { id: <ID>, type: "application" } in manifest.json
-                const manifest = yield (0, file_1.readJSON)((0, path_1.join)(manifestPath, constants_1.FileName.Manifest));
+                (_a = pathMap[manifestPath]) !== null && _a !== void 0 ? _a : (pathMap[manifestPath] = yield (0, file_1.readJSON)(manifestPath));
+                const manifest = pathMap[manifestPath];
                 if (!manifest['sap.app'] || !manifest['sap.app'].id || manifest['sap.app'].type !== 'application') {
                     continue;
                 }
                 const roots = yield findRootsForPath(manifestPath);
-                if (roots) {
+                if (roots && !(yield (0, file_1.fileExists)((0, path_1.join)(roots.appRoot, '.adp', constants_1.FileName.AdaptationConfig)))) {
                     result.push({ appRoot: roots.appRoot, projectRoot: roots.projectRoot, manifest, manifestPath });
                 }
             }
-            catch (_a) {
+            catch (_b) {
                 // ignore exceptions for invalid manifests
             }
         }
         return result;
     });
 }
-exports.findAllApps = findAllApps;
+/**
+ * Filter adaptation projects from a list of files.
+ *
+ * @param pathMap - map of files. Key is the path, on first read parsed content will be set as value to prevent multiple reads of a file.
+ * @returns - results as array of found adaptation projects.
+ */
+function filterAdaptations(pathMap) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const results = [];
+        const manifestAppDescrVars = Object.keys(pathMap).filter((path) => path.endsWith(constants_1.FileName.ManifestAppDescrVar));
+        for (const manifestAppDescrVar of manifestAppDescrVars) {
+            const adpPath = yield (0, file_1.findFileUp)('.adp', (0, path_1.dirname)(manifestAppDescrVar));
+            if (adpPath && (yield (0, file_1.fileExists)((0, path_1.join)(adpPath, constants_1.FileName.AdaptationConfig)))) {
+                results.push({ appRoot: (0, path_1.dirname)(adpPath) });
+            }
+        }
+        return results;
+    });
+}
+/**
+ * Filter extensions projects from a list of files.
+ *
+ * @param pathMap - map of files. Key is the path, on first read parsed content will be set as value to prevent multiple reads of a file.
+ * @returns - results as array of found extension projects.
+ */
+function filterExtensions(pathMap) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const results = [];
+        const extensionConfigs = Object.keys(pathMap).filter((path) => (0, path_1.basename)(path) === constants_1.FileName.ExtConfigJson);
+        for (const extensionConfig of extensionConfigs) {
+            try {
+                let manifest = null;
+                let manifestPath = Object.keys(pathMap).find((path) => path.startsWith((0, path_1.dirname)(extensionConfig) + path_1.sep) && (0, path_1.basename)(path) === constants_1.FileName.Manifest);
+                if (manifestPath) {
+                    (_a = pathMap[manifestPath]) !== null && _a !== void 0 ? _a : (pathMap[manifestPath] = yield (0, file_1.readJSON)(manifestPath));
+                    manifest = pathMap[manifestPath];
+                }
+                else {
+                    const manifests = yield (0, file_1.findBy)({
+                        fileNames: [constants_1.FileName.Manifest],
+                        root: (0, path_1.dirname)(extensionConfig),
+                        excludeFolders
+                    });
+                    if (manifests.length === 1) {
+                        [manifestPath] = manifests;
+                        manifest = yield (0, file_1.readJSON)(manifestPath);
+                    }
+                }
+                if (manifestPath && manifest) {
+                    results.push({ appRoot: (0, path_1.dirname)(extensionConfig), manifest, manifestPath });
+                }
+            }
+            catch (_b) {
+                // ignore exceptions for invalid manifests
+            }
+        }
+        return results;
+    });
+}
+/**
+ * Filter extensions projects from a list of files.
+ *
+ * @param pathMap - path to files
+ * @returns - results as array of found library projects.
+ */
+function filterLibraries(pathMap) {
+    var _a;
+    return __awaiter(this, void 0, void 0, function* () {
+        const results = [];
+        const manifestPaths = Object.keys(pathMap).filter((path) => (0, path_1.basename)(path) === constants_1.FileName.Manifest);
+        for (const manifestPath of manifestPaths) {
+            try {
+                (_a = pathMap[manifestPath]) !== null && _a !== void 0 ? _a : (pathMap[manifestPath] = yield (0, file_1.readJSON)(manifestPath));
+                const manifest = pathMap[manifestPath];
+                if (manifest['sap.app'] && manifest['sap.app'].type === 'library') {
+                    const packageJsonPath = yield (0, file_1.findFileUp)(constants_1.FileName.Package, (0, path_1.dirname)(manifestPath));
+                    const projectRoot = packageJsonPath ? (0, path_1.dirname)(packageJsonPath) : null;
+                    if (projectRoot && (yield (0, file_1.fileExists)((0, path_1.join)(projectRoot, constants_1.FileName.Ui5Yaml)))) {
+                        results.push({ projectRoot, manifestPath, manifest });
+                    }
+                }
+            }
+            catch (_b) {
+                // ignore exceptions for invalid manifests
+            }
+        }
+        return results;
+    });
+}
+/**
+ * Get the files to search for according to requested artifact type.
+ *
+ * @param artifacts - requests artifacts like apps, adaptations, extensions
+ * @returns - array of filenames to search for
+ */
+function getFilterFileNames(artifacts) {
+    const uniqueFilterFiles = new Set();
+    for (const artifact of artifacts) {
+        if (filterFileMap[artifact]) {
+            uniqueFilterFiles.add(filterFileMap[artifact]);
+        }
+    }
+    return Array.from(uniqueFilterFiles);
+}
+/**
+ * Find all requested Fiori artifacts like apps, adaptations, extensions, that are supported by Fiori tools, for a given list of roots (workspace folders).
+ *
+ * @param options - find options
+ * @param options.wsFolders - list of roots, either as vscode WorkspaceFolder[] or array of paths
+ * @param options.artifacts - list of artifacts to search for: 'application', 'adaptation', 'extension' see FioriArtifactTypes
+ * @returns - data structure containing the search results, for app e.g. as path to app plus files already parsed, e.g. manifest.json
+ */
+function findFioriArtifacts(options) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const results = {};
+        const fileNames = getFilterFileNames(options.artifacts);
+        const wsRoots = wsFoldersToRootPaths(options.wsFolders);
+        const pathMap = {};
+        for (const root of wsRoots) {
+            try {
+                const foundFiles = yield (0, file_1.findBy)({
+                    fileNames,
+                    root,
+                    excludeFolders
+                });
+                foundFiles.forEach((path) => (pathMap[path] = null));
+            }
+            catch (_a) {
+                // ignore exceptions during find
+            }
+        }
+        if (options.artifacts.includes('applications')) {
+            results.applications = yield filterApplications(pathMap);
+        }
+        if (options.artifacts.includes('adaptations')) {
+            results.adaptations = yield filterAdaptations(pathMap);
+        }
+        if (options.artifacts.includes('extensions')) {
+            results.extensions = yield filterExtensions(pathMap);
+        }
+        if (options.artifacts.includes('libraries')) {
+            results.libraries = yield filterLibraries(pathMap);
+        }
+        return results;
+    });
+}
+exports.findFioriArtifacts = findFioriArtifacts;
 //# sourceMappingURL=search.js.map

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

@@ -1,8 +1,82 @@
 import type { Manifest } from '../webapp';
+export type FioriArtifactTypes = 'applications' | 'adaptations' | 'extensions' | 'libraries';
+/**
+ * Search result when searching for apps. It is valid for all types of
+ * Fiori apps, like Fiori elements, UI5 freestyle, apps that are part
+ * of CAP projects.
+ */
 export interface AllAppResults {
+    /**
+     * Application root is where package.json and ui5.yaml resides.
+     */
     appRoot: string;
+    /**
+     * Project root is different from appRoot for CAP applications only,
+     * where the project root is the root of the CAP project. For all
+     * other applications it is the same as appRoot.
+     */
     projectRoot: string;
+    /**
+     * Path to the manifest.json, by default the webapp path but can be
+     * configured in ui5.yaml
+     */
     manifestPath: string;
+    /**
+     * Parsed content of the manifest.json to avoid multiple reads when working with
+     * the search results.
+     */
     manifest: Manifest;
 }
+/**
+ * Search result when searching for adaptation projects.
+ */
+export interface AdaptationResults {
+    /**
+     * Root of the adapted application where package.json and ui5.yaml resides.
+     */
+    appRoot: string;
+}
+/**
+ * Search result when searching for extension projects.
+ */
+export interface ExtensionResults {
+    /**
+     * Root of the extended application where package.json and ui5.yaml resides.
+     */
+    appRoot: string;
+    /**
+     * Path to the manifest.json, by default the webapp path but can be
+     * configured in ui5.yaml
+     */
+    manifestPath: string;
+    /**
+     * Parsed content of the manifest.json to avoid multiple reads when working with
+     * the search results.
+     */
+    manifest: Manifest;
+}
+/**
+ * Search result when searching for libraries.
+ */
+export interface LibraryResults {
+    /**
+     * Root of the library project, where package.json and ui5.yaml resides.
+     */
+    projectRoot: string;
+    /**
+     * Path to the manifest.json of the library.
+     */
+    manifestPath: string;
+    /**
+     * Parsed content of the manifest.json to avoid multiple reads when working with
+     * the search results.
+     */
+    manifest: Manifest;
+}
+export interface FoundFioriArtifacts {
+    applications?: AllAppResults[];
+    adaptations?: AdaptationResults[];
+    extensions?: ExtensionResults[];
+    libraries?: LibraryResults[];
+}
 //# sourceMappingURL=index.d.ts.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ux/project-access",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Library to access SAP Fiori tools projects",
   "repository": {
     "type": "git",